API 버전 관리 정보
GitHub REST API의 버전이 지정됩니다. API 버전의 이름은 API 버전이 릴리스된 날짜를 기반으로 합니다. 예를 들어 API 버전 2026-03-10은 Tue, 10 Mar 2026에 릴리스되었습니다.
파괴적인 변경은 통합을 손상시킬 수 있는 변경입니다. 호환성에 영향을 미치는 변경사항은 새 API 버전에서 릴리스됩니다. 중대한 변경 사항을 릴리스하기 전에 사전 통지를 드리겠습니다. 변경 사항에는 중요한 변화가 포함됩니다.
- 전체 작업 제거하기
- 매개 변수 이름 바꾸기 또는 제거하기
- 응답 필드 제거하기 또는 이름 바꾸기
- 새 필수 매개 변수 추가하기
- 이전에 선택적이었던 매개 변수를 필수로 만들기
- 매개 변수 또는 응답 필드의 형식 변경하기
- 열거형 값 제거하기
- 기존 매개 변수에 새 유효성 검사 규칙 추가하기
- 인증 또는 권한 부여 요구 사항 변경하기
모든 추가(호환 가능한) 변경 사항은 지원되는 모든 API 버전에서 사용할 수 있습니다. 추가 변경 내용은 통합을 중단해서는 안 되는 변경 내용입니다. 추가 변경 내용은 다음과 같습니다.
- 작업 추가하기
- 선택적 매개 변수 추가하기
- 선택적 요청 헤더 추가하기
- 응답 필드 추가하기
- 응답 헤더 추가하기
- 열거형 값 추가하기
새 REST API 버전이 릴리스되면 새 API 버전이 릴리스된 후 최소 24개월 동안만 이전 API 버전이 지원됩니다.
GitHub Enterprise Server 버전 관리 및 REST API 버전 관리 정보
GitHub Enterprise Server 버전은 REST API 버전에서 분리됩니다. 버전을 업그레이드하더라도 API 버전이 GitHub Enterprise Server 버전에 포함되어 있는 한 동일한 REST API 버전을 유지할 수 있습니다. 마찬가지로, GitHub Enterprise Server 버전에서 사용할 수 있는 새 REST API 버전을 선택하면, GitHub Enterprise Server 버전을 업데이트하지 않고도 REST API 버전을 업그레이드할 수 있습니다.
릴리스 정보에는 GitHub Enterprise Server REST API 버전이 더 이상 지원되지 않는 경우 표시됩니다. 자세한 내용은 릴리스 정보을(를) 참조하세요.
API 버전 지정
`X-GitHub-Api-Version` 헤더를 사용하여 API 버전을 지정해야 합니다. 예시:
curl --header "X-GitHub-Api-Version:2022-11-28" https://api.github.com/zen
`X-GitHub-Api-Version` 헤더가 없는 요청은 기본적으로 `2022-11-28` 버전을 사용합니다.
더 이상 지원되지 않는 API 버전을 지정하면 응답을 받게 됩니다 410 Gone .
새 API 버전으로 업그레이드
새 REST API 버전으로 업그레이드하기 전에 새 API 버전에 해당하는 호환성이 손상되는 변경을 확인하고 포함된 호환성이 손상되는 변경 내용을 이해하고 해당 특정 API 버전으로 업그레이드하는 방법에 대해 자세히 알아봅니다. 자세한 내용은 주요 변경사항을(를) 참조하세요.
`X-GitHub-Api-Version` 헤더에서 새 API 버전을 지정하도록 통합을 업데이트할 때, 새 API 버전에 맞추어 통합이 작동하도록 필요한 변경을 해야 합니다.
통합이 업데이트되면 통합을 테스트하여 새 API 버전에서 작동하는지 확인합니다.
API 버전 사용되지 않음
API 버전은 최신 API 버전이 릴리스된 후 24개월 동안 지원됩니다.
버전이 지원 기간 내에 있지만 종료에 가까워질 때, 마이그레이션 준비에 도움이 되도록 API 응답에 다음 헤더가 포함됩니다: 사용되지 않음, GitHub.
Deprecation— API 버전이 될 날짜이며 사용되지 않음당 HTTP 날짜로 형식이 지정됩니다. 예:Wed, 27 Nov 2019 14:34:29 GMT.Sunset— API 버전이 완전히 제거되는 날짜()종료이며, 그 후에 요청이 응답을 반환410 Gone합니다. RFC 8594를 따릅니다. 예:Fri, 27 Nov 2020 14:34:29 GMT.
지원 창이 종료된 후:
- API 버전을 지정하는 요청은 사용되지 않음 응답을 받습니다
410 Gone. - API 버전을 지정하지 않는 요청은 사용되지 않음 버전이 아닌 가장 오래된 지원 버전 다음으로 기본 설정됩니다. 확인되지 않은 요청에 의존하는 경우 이전 버전이 지원에서 제거됨에 따라 동작 변경이 관찰될 수 있습니다.
최신 API 버전으로 마이그레이션하는 방법에 대한 자세한 내용은 주요 변경사항을 참조하세요.
표준 버전 관리 예외
드문 경우로 일반 GitHub API 버전 관리 주기 외부에서 변경이 발생할 수 있습니다. 이러한 작업은 대부분의 통합자에 대한 표준 버전 관리 보장을 변경하지 않는 예외적인 개입입니다.
보안, 가용성 및 안정성 문제
중요한 보안 취약성, 데이터 노출 위험 또는 심각한 안정성 문제로 정상적인 릴리스 일정을 벗어나는 변경이 필요할 수 있습니다. GitHub 에서는 예약되지 않은 API 버전, 지원되는 버전에 대한 백포트 수정을 릴리스하거나 드문 경우에서 사용자 및 플랫폼 무결성을 보호하기 위해 기존 버전에 호환성이 손상되는 변경을 도입할 수 있습니다.
GitHub 는 릴리스 정보, 변경 로그 및 변경 내용 및 이유를 설명하는 직접 통신을 통해 이러한 변경 내용을 전달합니다. 가능한 경우 사전 통지가 제공됩니다. 필요한 경우 사전 통지 없이 즉각적인 조치를 취할 수 있습니다.
사용량이 적은 서비스
사용량이 GitHub 매우 낮은 특정 서비스의 경우 표준 버전 관리 프로세스 외부의 기능은 더 이상 사용되지 않을 수 있습니다. 이러한 경우 GitHub 의도를 전달하고 영향을 받는 통합자에게 직접 연락합니다.
지원되는 API 버전
현재 지원되는 REST API 버전은 다음과 같습니다.
| API 버전 | 지원 종료 날짜 |
|---|---|
2022-11-28 | March 10, 2028 |
API 요청을 만들어 지원되는 모든 API 버전을 가져올 수도 있습니다. 자세한 내용은 메타 데이터에 대한 REST API 엔드포인트을(를) 참조하세요.