API 버전 관리와 폐기 정책

인블로그 API v1의 현재 지원 상태와 향후 폐기 신호, 지원 종료 고지 원칙을 안내합니다.

인블로그 REST API는 URL 경로에 버전을 표시하므로 자동화 도구가 예측 가능한 계약을 사용할 수 있습니다.

현재 지원 상태

v1은 현재 지원하는 REST API 버전입니다. 연동을 만들 때는 /api/v1/... 아래의 엔드포인트와 OpenAPI 문서를 사용하세요.

지원되는 v1 작업에서는 하위 호환성을 유지합니다. 응답 필드 추가처럼 호환성을 깨지 않는 개선은 새 URL 버전을 만들지 않고 제공할 수 있습니다. 현재 v1에 대해 공지된 폐기 또는 지원 종료 일정은 없습니다.

이 정책이 존재한다는 이유만으로 v1 응답에 Deprecation 또는 Sunset 응답 헤더를 현재 보내지는 않습니다. 두 헤더가 없다는 것은 아직 지원 종료 신호가 공지되지 않았다는 뜻입니다.

지원 중인 API 버전의 종료가 예정되면 인블로그는 다음 응답 헤더를 사용할 수 있습니다.

두 신호는 서로 다릅니다. 폐기는 수명주기 변경의 시작을 알리고, Sunset은 지원 종료 예정일을 나타냅니다. 헤더가 제공되면 클라이언트는 두 값을 기록하고 연결된 문서와 마이그레이션 안내를 확인해야 합니다.

일반 원칙으로, v1을 제거하거나 지원 중인 API 버전에 호환성이 깨지는 변경을 하기 전에 최소 180일의 고지 기간을 제공합니다. 이는 보수적인 최소 기준이며, 모든 변경이 반드시 그 일정으로 진행된다는 뜻은 아닙니다.

보안 취약점, 법적 의무 또는 긴급 상황에서는 더 짧은 고지나 즉시 변경이 필요할 수 있습니다. 이런 경우에도 가능한 한 빨리 영향과 대응 방법을 안내합니다.