REST API

프로그래밍 방식으로 GitLab과 상호 작용하기 위해 GitLab REST API를 사용합니다. 요청, 속도 제한, 페이지 매김, 인코딩, 버전 관리 및 응답 처리가 포함됩니다.

GitLab REST API로 워크플로를 자동화하고 통합 기능을 구축합니다. 수동 개입 없이 GitLab 리소스를 대규모로 관리하는 맞춤 도구를 만듭니다. GitLab 데이터를 애플리케이션에 직접 통합해 협업을 개선합니다. 여러 프로젝트에 걸친 CI/CD 프로세스를 정밀하게 관리합니다. 사용자 액세스를 프로그래밍 방식으로 제어해 조직 전체에서 일관된 권한을 유지합니다. REST API는 표준 HTTP 메서드와 JSON 데이터 형식을 사용하므로 기존 도구 및 시스템과 호환됩니다. REST API 요청 보내기 # REST API 요청은 다음과 같이 보냅니다. REST API 클라이언트로 API 엔드포인트에 요청을 제출합니다. GitLab 인스턴스가 요청에 응답합니다. 상태 코드와, 해당하는 경우 요청한 데이터를 반환합니다. 상태 코드는 요청의 결과를 나타내며 문제 해결 에 유용합니다. REST API 요청은 루트 엔드포인트와 경로로 시작해야 합니다. 루트 엔드포인트는 GitLab 호스트 이름입니다. 경로는 /api/v4 로 시작해야 합니다( v4 는 API 버전을 나타냅니다). 다음 예시에서 API 요청은 GitLab 호스트 gitlab.example.com 의 모든 프로젝트 목록을 조회합니다. curl --request GET \ --url "https://gitlab.example.com/api/v4/projects" 일부 엔드포인트는 접근에 인증이 필요합니다. 자세한 내용은 인증 을 참고합니다. 속도 제한 # REST API 요청에는 속도 제한 설정이 적용됩니다. 이 설정은 GitLab 인스턴스에 과부하가 걸릴 위험을 줄입니다. 자세한 내용은 속도 제한 을 참고합니다. GitLab.com에 적용되는 속도 제한 설정은 GitLab.com 전용 속도 제한 을 참고합니다. 응답 형식 # REST API 응답은 JSON 형식으로 반환됩니다. 일부 API 엔드포인트는 일반 텍스트 형식도 지원합니다. 엔드포인트가 지원하는 콘텐츠 유형은 REST API 리소스 에서 확인합니다. 요청 요건 # 일부 REST API 요청에는 사용하는 데이터 형식과 인코딩 등 별도의 요건이 있습니다. 요청 페이로드 # API 요청은 쿼리 문자열 로 전달하는 파라미터나 페이로드 본문 으로 전달하는 파라미터를 사용할 수 있습니다. GET 요청은 보통 쿼리 문자열을 보내고, PUT 또는 POST 요청은 보통 페이로드 본문을 보냅니다. 쿼리 문자열: curl --request POST \ --url "https://gitlab.example.com/api/v4/projects?name=<example-name>&description=<example-description>" 요청 페이로드(JSON): curl --request POST \ --header "Content-Type: application/json" \ --data '{"name":"<example-name>", "description":"<example-descript