API 버전 관리 정보
GitHub REST API의 버전이 지정됩니다. API 버전 이름은 API 버전이 릴리스된 날짜를 기반으로 합니다. 예를 들어 API 버전은 2022-11-28 Mon, 28 Nov 2022에 릴리스되었습니다.
호환성이 손상되는 모든 변경 내용은 새 API 버전에서 릴리스됩니다. 호환성이 손상되는 변경은 통합을 손상시킬 수 있는 변경 내용입니다. 호환성이 손상되는 변경 내용은 다음과 같습니다.
- 전체 작업 제거
- 매개 변수 제거 또는 이름 바꾸기
- 응답 필드 제거 또는 이름 바꾸기
- 새 필수 매개 변수 추가
- 이전에 선택적 매개 변수를 필수로 만들기
- 매개 변수 또는 응답 필드의 형식 변경
- 열거형 값 제거
- 기존 매개 변수에 새 유효성 검사 규칙 추가
- 인증 또는 권한 부여 요구 사항 변경
모든 추가(호환성이 손상되지 않는) 변경 내용은 지원되는 모든 API 버전에서 사용할 수 있습니다. 추가 변경 내용은 통합을 중단해서는 안 되는 변경 내용입니다. 추가 변경 내용은 다음과 같습니다.
- 작업 추가
- 선택적 매개 변수 추가
- 선택적 요청 헤더 추가
- 응답 필드 추가
- 응답 헤더 추가
- 열거형 값 추가
새 REST API 버전이 릴리스되면 새 API 버전이 릴리스된 후 최소 24개월 동안 이전 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 버전을 지정하면 오류가 발생합니다 400 .
새 API 버전으로 업그레이드
새 REST API 버전으로 업그레이드하기 전에 새 API 버전에 대한 호환성이 손상되는 변경 내용의 변경 로그를 읽고 포함된 주요 변경 내용을 이해하고 해당 특정 API 버전으로 업그레이드하는 방법에 대해 자세히 알아보세요. 자세한 내용은 "호환성이 손상되는 변경"을 참조하세요.
헤더에서 X-GitHub-Api-Version 새 API 버전을 지정하도록 통합을 업데이트하는 경우 통합이 새 API 버전과 함께 작동하도록 하는 데 필요한 변경도 수행해야 합니다.
통합이 업데이트되면 통합을 테스트하여 새 API 버전에서 작동하는지 확인합니다.
지원되는 API 버전
현재 지원되는 REST API 버전은 다음과 같습니다.
2022-11-28
API 요청을 만들어 지원되는 모든 API 버전을 가져올 수도 있습니다. 자세한 내용은 "모든 API 버전 가져오기"를 참조하세요.