OpenAPI 설명 정보
OpenAPI는 REST API를 설명하기 위한 표준 사양입니다. OpenAPI 설명을 사용하면 사용자와 머신이 먼저 설명서를 읽거나 구현을 이해할 필요 없이 API의 기능을 검색할 수 있습니다. GitHub는 REST API를 OpenAPI 3.0 규격 문서로 공개적으로 사용할 수 있게 되었습니다.
GitHub OpenAPI 설명 가져오기
오픈 소스 REST API OpenAPI 설명 리포지토리에서 설명을 찾을 수 있습니다.
설명은 두 가지 형식으로 제공합니다. 번들 버전은 재사용 및 가독성을 위해 OpenAPI 구성 요소를 포함하므로 대부분의 경우에 작동합니다. 도구가 구성 요소에 대한 인라인 참조를 지원하지 않는 경우 완전히 역참조된 버전도 제공합니다.
GitHub OpenAPI 설명 사용
OpenAPI 설명에는 많은 용도가 있습니다. 예를 들어 다음과 같이 할 수 있습니다.
- 사용자 고유의 API 클라이언트를 생성합니다.
- GitHub REST API 통합의 유효성을 검사하고 테스트합니다.
- Insomnia 또는 Postman과 같은 타사 도구를 사용하여 GitHub Enterprise Server REST API를 탐색하고 상호 작용합니다.
예를 들어 GitHub는 REST OpenAPI 설명을 사용하여 GitHub Enterprise Server REST API 참조 설명서를 생성합니다.