API 수명 종료(EOL) 프로세스 및 마이그레이션 가이드
이 페이지는 모든 API 엔드포인트의 수명 종료(EOL, End of Life) 주기와 관련된 프로세스, 주요 날짜 및 마일스톤을 설명합니다. 또한 이 문서에서는 수명 종료 프로세스가 진행 중인 API 엔드포인트에 대한 주요 날짜 및 마이그레이션 가이드에 대한 자세한 정보를 확인할 수 있습니다.
API 수명 종료(EOL) 프로세스
Snyk GA REST API는 Snyk V1 API보다 발전된 형태입니다. GA REST API는 다음과 같은 특징을 갖기 때문입니다.
일관된 버전 관리
페이지네이션 및 캐싱
성능 향상
클라이언트 생성을 위한 사양 제공
Snyk V1 API의 수명 종료 및 GA REST API로의 교체는 기존 V1 API에 비해 이러한 개선 사항을 구현할 것입니다. Snyk이 더 많은 GA REST API를 제공함에 따라, REST API의 실험적(experimental) 및 베타(beta) 버전도 수명 종료에 도달하게 됩니다.
V1 API에서 GA REST로 마이그레이션하는 것은 시간이 많이 걸리는 프로세스일 수 있으며, Snyk은 여러분이 마이그레이션을 계획하고 실행하여 가능한 한 빨리 최상의 API 경험을 누릴 수 있도록 충분한 시간을 제공하고자 합니다. GA REST로의 원활한 마이그레이션을 위해 엔드포인트(V1, 실험적 또는 베타 API)를 EOL로 전환하는 프로세스는 다음과 같습니다.
엔드포인트 묶음은 일 년에 두 번(1월과 7월) 시작되는 EOL 주기에 포함됩니다.
API 엔드포인트는 다음 조건들을 충족하는 경우에만 EOL에 포함될 수 있습니다.
GA REST 대체 엔드포인트가 존재하는 경우 (단, V1 API가 GA REST 대체 엔드포인트가 필요하지 않은 드문 경우는 제외)
V1과 GA REST 간의 기능적 동등성(Parity)이 보장되는 경우 (마이그레이션 가이드에 명시적으로 다르게 기재된 경우 제외)
마이그레이션의 편의를 위해 현장 전문가가 작성한 마이그레이션 가이드가 제공되는 경우
Snyk은 주기가 시작되기 한 달 전에 어떤 엔드포인트가 EOL 주기에 포함될지 공개적으로 발표합니다.
EOL이 시작되는 날짜에 해당 엔드포인트는 **지원 종료(deprecated)**된 것으로 간주됩니다. 그 시점에서 각 엔드포인트의 문서는 제거되거나 엔드포인트가 지원 종료되었다는 문구가 추가됩니다. 또한, 새로운 고객은 해당 엔드포인트와 통합할 수 없습니다. 기존 고객의 경우 수명 종료 날짜까지 해당 엔드포인트를 계속 사용할 수 있습니다. 수명 종료에 도달하는 모든 엔드포인트와 관련 일정은 API EOL 엔드포인트 및 주요 날짜 페이지에서 확인할 수 있습니다.
EOL 기간 동안 매월 Snyk은 지정된 엔드포인트의 기능을 일시적으로 중단하며, EOL이 진행됨에 따라 중단 기간을 점차 늘려갑니다.
EOL 날짜에 도달하면 엔드포인트 작동이 중지되고 오류가 발생합니다.
API EOL 유형
각 주기 동안 다음과 같은 유형의 EOL이 발생합니다.
V1 API: GA REST 대체 엔드포인트가 출시되면, Snyk은 가능한 한 빨리 해당 V1 API를 수명 종료 주기에 포함하는 것을 목표로 합니다. 사용자는 1월과 7월의 공개 발표 시점부터 6개월의 마이그레이션 기간을 갖게 됩니다.
실험적(experimental) 및 베타(beta): Snyk이 이전의 실험적 또는 베타 엔드포인트가 있는 REST 엔드포인트를 GA로 업그레이드하면, 가능한 한 빨리 이들을 EOL 주기에 포함하는 것을 목표로 합니다. 사용자는 1월과 7월의 공개 발표 시점부터 3개월의 마이그레이션 기간을 갖게 됩니다.
예외적인 상황에서 Snyk은 매년 1월과 7월에 이루어지는 두 번의 발표 외에 엔드포인트에 대한 EOL을 발표해야 할 수도 있습니다. 이 경우 사용자는 EOL 주기에 대해 한 달 전에 통지를 받게 됩니다. 엔드포인트에서 마이그레이션하기 위한 시간 창은 각 EOL 유형(V1 API 또는 실험적/베타 엔드포인트)에 대해 정의된 것과 동일하게 적용됩니다.
Last updated