Skip to main content

REST API에 대한 OpenAPI 설명 정보

GitHub Enterprise Server REST API는 OpenAPI 규격 문서에 완전히 설명되어 있습니다.

OpenAPI 정보

OpenAPI는 REST API 인터페이스를 기술하기 위한 사양입니다. 소스 코드나 추가 설명서에 액세스하지 않고도 API를 설명합니다. 사양은 사람과 컴퓨터가 모두 읽을 수 있습니다. 자세한 내용은 OpenAPI 사양 설명서서을 참조하세요.

GitHub의 OpenAPI 설명 정보

REST API에 대한 GitHub의 OpenAPI 설명을 공개적으로 제공되어 있습니다. 오픈 소스 github/rest-api-description 리포지토리에서 설명을 찾을 수 있습니다.

GitHub은(는) 3.0 및 3.1 OpenAPI 설명을 모두 제공합니다.

각 설명에는 각 제품에 대한 버전 GitHub Free/GitHub Pro/GitHub Team(api.github.com), GitHub Enterprise Cloud(ghec) 및 각 버전의 GitHub Enterprise Server(ghes-X.X)이(가) 있습니다.

각 제품에 대해 날짜 기반 버전 관리가 지원되는 경우 각 날짜 기반 버전에 대한 설명도 있습니다. 자세한 내용은 "API 버전"을(를) 참조하세요.

각 설명은 번들 형식 또는 역참조 형식으로 제공됩니다. 번들 형식은 $ref을(를) 사용하여 엔드포인트 간에 공유되는 OpenAPI 구성 요소를 참조합니다. 역참조 형식에는 완전히 확장된 설명이 포함됩니다.

GitHub OpenAPI 설명 사용

OpenAPI 설명은 컴퓨터에서 읽을 수 있으므로 다음과 같은 작업을 수행하는 데 사용할 수 있습니다.

  • REST API를 쉽게 사용할 수 있도록 라이브러리 생성
  • REST API를 사용하는 통합 유효성 검사 및 테스트
  • Insomnia 또는 Postman과 같은 제3자 도구를 사용하여 REST API를 탐색하고 상호 작용합니다.

예를 들어 GitHub은(는) OpenAPI 설명을 사용하여 Octokit SDK를 생성합니다. GitHub은(는) OpenAPI 설명을 사용하여 각 엔드포인트에 대한 REST API 참조 설명서를 생성합니다.