Ruby gems API
이것은 Ruby gems에 대한 API 문서입니다.
경고: 이 API는 Ruby gems 및 Bundler 패키지 관리자 클라이언트에서 사용되며 일반적으로 수동으로 사용하기 위한 것이 아닙니다. 이 API는 개발 중이며 기능이 제한적이기 때문에 프로덕션 환경에서 사용할 준비가되지 않았습니다.
GitLab 패키지 레지스트리에서 gem을 업로드하고 설치하는 방법에 대한 지침은 Ruby gems 레지스트리 문서를 참조하십시오.
참고: 이 엔드포인트는 표준 API 인증 방법을 따르지 않습니다. 지원되는 헤더 및 토큰 유형에 대한 자세한 내용은 Ruby gems 레지스트리 문서를 참조하십시오. 문서화되지 않은 인증 방법은 향후에 제거 될 수 있습니다.
Ruby gems API 활성화
GitLab의 Ruby gems API는 기본적으로 사용되지 않는 기능 플래그 뒤에 있습니다. GitLab Ruby 콘솔에 액세스 할 수있는 관리자는 이 API를 인스턴스에 대해 활성화 할 수 있습니다.
활성화하려면:
Feature.enable(:rubygem_packages)
비활성화하려면:
Feature.disable(:rubygem_packages)
특정 프로젝트에 대해 활성화 또는 비활성화하려면:
Feature.enable(:rubygem_packages, Project.find(1))
Feature.disable(:rubygem_packages, Project.find(2))
gem 파일 다운로드
gem을 다운로드:
GET projects/:id/packages/rubygems/gems/:file_name
| 속성 | 유형 | 필수 | 설명 |
|---|---|---|---|
id
| string | yes | 프로젝트의 ID 또는 전체 경로. |
file_name
| string | yes |
.gem 파일의 이름.
|
curl --header "Authorization:<personal_access_token>" "https://gitlab.example.com/api/v4/projects/1/packages/rubygems/gems/my_gem-1.0.0.gem"
파일로 출력:
curl --header "Authorization:<personal_access_token>" "https://gitlab.example.com/api/v4/projects/1/packages/rubygems/gems/my_gem-1.0.0.gem" >> my_gem-1.0.0.gem
다운로드 된 파일을 현재 디렉토리의 my_gem-1.0.0.gem에 작성합니다.
종속 항목 목록 가져오기
여러 gem에 대한 종속성 목록을 가져옵니다:
GET projects/:id/packages/rubygems/api/v1/dependencies
| 속성 | 유형 | 필수 | 설명 |
|---|---|---|---|
id
| string | yes | 프로젝트의 ID 또는 전체 경로. |
gems
| string | no | 종속성을 가져올 gem의 쉼표로 구분 된 목록. |
curl --header "Authorization:<personal_access_token>" "https://gitlab.example.com/api/v4/projects/1/packages/rubygems/api/v1/dependencies?gems=my_gem,foo"
이 엔드포인트는 요청 된 gem의 모든 버전에 대한 해시 배열을 반환합니다. 응답이 해싱되었으므로 파일에 저장할 수 있습니다. Ruby가 설치되어있는 경우 다음 Ruby 명령을 사용하여 응답을 읽을 수 있습니다. 이 작업을 수행하려면 .gem/credentials에 자격 증명을 설정해야합니다:
$ ruby -ropen-uri -rpp -e \
'pp Marshal.load(open("https://gitlab.example.com/api/v4/projects/1/packages/rubygems/api/v1/dependencies?gems=my_gem,rails,foo"))'
이 명령은 현재 디렉토리의 mypkg-1.0-SNAPSHOT.jar에 다운로드 한 파일을 작성합니다.
gem 업로드
gem을 업로드:
POST projects/:id/packages/rubygems/api/v1/gems
| 속성 | 유형 | 필수 | 설명 |
|---|---|---|---|
id
| string | yes | 프로젝트의 ID 또는 전체 경로. |
curl --request POST \
--upload-file path/to/my_gem_file.gem \
--header "Authorization:<personal_access_token>" \
"https://gitlab.example.com/api/v4/projects/1/packages/rubygems/api/v1/gems"
도움말