OpenAPI
OpenAPI 3.0 사양으로 GitLab REST API를 살펴보는 방법을 설명합니다.
GitLab은 RESTful API를 설명하는 표준적이고 플랫폼 독립적인 형식인 OpenAPI 3.0 사양 (이전 명칭 Swagger)으로 REST API를 문서화합니다. API 코드가 REST API의 단일 진실 공급원입니다. OpenAPI 사양은 API 코드에서 직접 자동 생성되며 구현과 긴밀하게 결합되어 있으므로, 문서가 항상 정확하고 최신 상태로 유지됩니다. GitLab API에 대한 일반적인 내용은 GitLab으로 확장 을 참고합니다. OpenAPI 사양 파일 # 원본 OpenAPI 3.0 사양은 GitLab 모노레포에서 제공됩니다. 파일: doc/api/openapi/openapi_v3.yaml 형식: OpenAPI 3.0(YAML) Note OpenAPI 2.0 사양( openapi_v2.yaml )은 지원 중단되었으며 더 이상 업데이트되지 않습니다. 대신 OpenAPI 3.0 사양( openapi_v3.yaml )을 사용합니다. 대화형 REST API 문서 # REST API는 OpenAPI 3.0 사양으로 전체가 문서화되어 있습니다. REST API 문서 에서 모든 엔드포인트를 대화형으로 살펴보고 테스트할 수 있습니다. 이 문서는 오픈 소스 API 참조 도구인 Scalar 로 렌더링됩니다. GitLab 소스 코드의 OpenAPI 사양에서 자동으로 생성되므로 항상 API의 현재 상태를 반영합니다. 인가 자격 증명 추가 # 일부 엔드포인트는 인증이 필요합니다. GitLab은 HTTP Bearer 또는 OAuth 2.0 자격 증명을 사용한 인증을 지원합니다. 인가 자격 증명을 추가하려면 다음을 수행합니다. REST API 문서 로 이동합니다. 오른쪽의 Authentication 패널에서 드롭다운 목록의 인증 방법을 선택합니다. 자격 증명을 입력합니다. http 의 경우 개인 액세스 토큰 을 입력합니다. oauth2 의 경우 GitLab을 ID 공급자로 사용하는 인가 코드 흐름을 사용합니다. Authorize 를 선택합니다. 자격 증명은 세션 중 이후의 모든 요청에 자동으로 재사용됩니다. 실시간 요청 보내기 # 대화형 요청 도구를 사용해 GitLab에 실시간 요청을 보냅니다. 실시간 요청을 보내려면 다음을 수행합니다. REST API 문서 로 이동합니다. 작업을 확장합니다. Test Request 를 선택합니다. 필수 또는 선택 매개변수를 입력합니다. Send 를 선택합니다. 이 도구는 curl 명령, 전체 요청 URL, 서버 응답을 표시합니다.