Conan API

Tier: Free, Premium, Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated

이 문서는 Conan Packages에 대한 API 문서입니다.

caution
이 API는 Conan 패키지 관리자 클라이언트에 의해 사용되며, 일반적으로 수동으로 사용하기 위한 것이 아닙니다.

GitLab 패키지 레지스트리에서 Conan 패키지를 업로드하고 설치하는 방법에 대한 지침은 Conan 패키지 레지스트리 문서를 참조하세요.

note
이 엔드포인트는 표준 API 인증 방법을 준수하지 않습니다. 각 경로를 참조하여 자격 증명이 어떻게 전달되는지 확인하세요. 문서화되지 않은 인증 방법은 향후 제거될 수 있습니다.
note
Conan 레지스트리는 FIPS 준수하지 않으며 FIPS 모드가 활성화되면 비활성화됩니다. 이 엔드포인트는 모두 404 Not Found를 반환합니다.

Route prefix

두 세트의 동일한 경로가 있으며 각기 다른 범위에서 요청을 수행합니다:

  • 인스턴스 수준 접두사를 사용하여 GitLab 인스턴스 전체의 범위에서 요청을 수행합니다.
  • 프로젝트 수준 접두사를 사용하여 단일 프로젝트의 범위에서 요청을 수행합니다.

이 문서의 예시는 모두 인스턴스 수준 접두사를 사용합니다.

Instance-level

/packages/conan/v1  

인스턴스 수준 경로를 사용할 때에는 Conan 레시피에 대한
명명 제한을 유의하세요.

Project-level

/projects/:id/packages/conan/v1  
속성 유형 필수 설명
id string 프로젝트 ID 또는 전체 프로젝트 경로.

Ping

GitLab Conan 레포지토리에 핑을 보내 가용성을 확인합니다:

GET <route-prefix>/ping  
curl "https://gitlab.example.com/api/v4/packages/conan/v1/ping"  

예시 응답:

""  

이름으로 Conan 패키지를 검색합니다:

GET <route-prefix>/conans/search  
속성 유형 필수 설명
q string 검색 쿼리. *를 와일드카드로 사용할 수 있습니다.
curl --user <username>:<personal_access_token> "https://gitlab.example.com/api/v4/packages/conan/v1/conans/search?q=Hello*"  

예시 응답:

{  
  "results": [  
    "Hello/0.1@foo+conan_test_prod/beta",  
    "Hello/0.1@foo+conan_test_prod/stable",  
    "Hello/0.2@foo+conan_test_prod/beta",  
    "Hello/0.3@foo+conan_test_prod/beta",  
    "Hello/0.1@foo+conan-reference-test/stable",  
    "HelloWorld/0.1@baz+conan-reference-test/beta"  
    "hello-world/0.4@buz+conan-test/alpha"  
  ]  
}  

Authenticate

Bearer 헤더를 사용하여 Conan 요청에 사용할 JWT를 반환합니다:

"Authorization: Bearer <token>  

Conan 패키지 관리자 클라이언트는 이 토큰을 자동으로 사용합니다.

GET <route-prefix>/users/authenticate  
curl --user <username>:<personal_access_token> "https://gitlab.example.com/api/v4/packages/conan/v1/users/authenticate"  

예시 응답:

eyJhbGciOiJIUzI1NiIiheR5cCI6IkpXVCJ9.eyJhY2Nlc3NfdG9rZW4iOjMyMTQyMzAsqaVzZXJfaWQiOjQwNTkyNTQsImp0aSI6IjdlNzBiZTNjLWFlNWQtNDEyOC1hMmIyLWZiOThhZWM0MWM2OSIsImlhd3r1MTYxNjYyMzQzNSwibmJmIjoxNjE2NjIzNDMwLCJleHAiOjE2MTY2MjcwMzV9.QF0Q3ZIB2GW5zNKyMSIe0HIFOITjEsZEioR-27Rtu7E  

자격 증명 확인

Basic Auth 자격 증명 또는 /authenticate에서 생성된 Conan JWT의 유효성을 검사합니다.

GET <route-prefix>/users/check_credentials
curl --header "Authorization: Bearer <authenticate_token>" "https://gitlab.example.com/api/v4/packages/conan/v1/users/check_credentials"

예시 응답:

ok

레시피 스냅샷

지정된 Conan 레시피의 레시피 파일 스냅샷을 반환합니다. 스냅샷은 해당 md5 해시와 함께 파일 이름의 목록입니다.

GET <route-prefix>/conans/:package_name/:package_version/:package_username/:package_channel
속성 유형 필수 설명
package_name string 패키지의 이름입니다.
package_version string 패키지의 버전입니다.
package_username string 패키지의 Conan 사용자 이름입니다. 이 속성은 프로젝트의 +로 구분된 전체 경로입니다.
package_channel string 패키지의 채널입니다.
curl --header "Authorization: Bearer <authenticate_token>" "https://gitlab.example.com/api/v4/packages/conan/v1/conans/my-package/1.0/my-group+my-project/stable"

예시 응답:

{
  "conan_sources.tgz": "eadf19b33f4c3c7e113faabf26e76277",
  "conanfile.py": "25e55b96a28f81a14ba8e8a8c99eeace",
  "conanmanifest.txt": "5b6fd77a2ba14303ce4cdb08c87e82ab"
}

패키지 스냅샷

지정된 Conan 참조로 지정된 Conan 레시피의 패키지 파일 스냅샷을 반환합니다. 스냅샷은 해당 md5 해시와 함께 파일 이름의 목록입니다.

GET <route-prefix>/conans/:package_name/:package_version/:package_username/:package_channel/packages/:conan_package_reference
속성 유형 필수 설명
package_name string 패키지의 이름입니다.
package_version string 패키지의 버전입니다.
package_username string 패키지의 Conan 사용자 이름입니다. 이 속성은 프로젝트의 +로 구분된 전체 경로입니다.
package_channel string 패키지의 채널입니다.
conan_package_reference string Conan 패키지의 참조 해시입니다. Conan이 이 값을 생성합니다.
curl --header "Authorization: Bearer <authenticate_token>" "https://gitlab.example.com/api/v4/packages/conan/v1/conans/my-package/1.0/my-group+my-project/stable/packages/103f6067a947f366ef91fc1b7da351c588d1827f"

예시 응답:

{
  "conan_package.tgz": "749b29bdf72587081ca03ec033ee59dc",
  "conaninfo.txt": "32859d737fe84e6a7ccfa4d64dc0d1f2",
  "conanmanifest.txt": "a86b398e813bd9aa111485a9054a2301"
}

레시피 매니페스트

매니페스트는 레시피 파일 이름과 해당 다운로드 URL 목록입니다.

GET <route-prefix>/conans/:package_name/:package_version/:package_username/:package_channel/digest
속성 타입 필수 설명
package_name string 패키지의 이름입니다.
package_version string 패키지의 버전입니다.
package_username string 패키지의 Conan 사용자 이름입니다. 이 속성은 프로젝트의 +로 구분된 전체 경로입니다.
package_channel string 패키지의 채널입니다.
curl --header "Authorization: Bearer <authenticate_token>" "https://gitlab.example.com/api/v4/packages/conan/v1/conans/my-package/1.0/my-group+my-project/stable/digest"

예시 응답:

{
  "conan_sources.tgz": "https://gitlab.example.com/api/v4/packages/conan/v1/files/my-package/1.0/my-group+my-project/stable/0/export/conan_sources.tgz",
  "conanfile.py": "https://gitlab.example.com/api/v4/packages/conan/v1/files/my-package/1.0/my-group+my-project/stable/0/export/conanfile.py",
  "conanmanifest.txt": "https://gitlab.example.com/api/v4/packages/conan/v1/files/my-package/1.0/my-group+my-project/stable/0/export/conanmanifest.txt"
}

응답의 URL는 요청에 사용된 동일한 경로 접두사를 가지고 있습니다. 프로젝트 수준 경로로 요청하면 반환된 URL에 /projects/:id가 포함됩니다.

패키지 매니페스트

매니페스트는 패키지 파일 이름과 해당 다운로드 URL 목록입니다.

GET <route-prefix>/conans/:package_name/:package_version/:package_username/:package_channel/packages/:conan_package_reference/digest
속성 타입 필수 설명
package_name string 패키지의 이름입니다.
package_version string 패키지의 버전입니다.
package_username string 패키지의 Conan 사용자 이름입니다. 이 속성은 프로젝트의 +로 구분된 전체 경로입니다.
package_channel string 패키지의 채널입니다.
conan_package_reference string Conan 패키지의 참조 해시입니다. Conan이 이 값을 생성합니다.
curl --header "Authorization: Bearer <authenticate_token>" "https://gitlab.example.com/api/v4/packages/conan/v1/conans/my-package/1.0/my-group+my-project/stable/packages/103f6067a947f366ef91fc1b7da351c588d1827f/digest"

예시 응답:

{
  "conan_package.tgz": "https://gitlab.example.com/api/v4/packages/conan/v1/files/my-package/1.0/my-group+my-project/stable/packages/103f6067a947f366ef91fc1b7da351c588d1827f/0/conan_package.tgz",
  "conaninfo.txt": "https://gitlab.example.com/api/v4/packages/conan/v1/files/my-package/1.0/my-group+my-project/stable/packages/103f6067a947f366ef91fc1b7da351c588d1827f/0/conaninfo.txt",
  "conanmanifest.txt": "https://gitlab.example.com/api/v4/packages/conan/v1/files/my-package/1.0/my-group+my-project/stable/packages/103f6067a947f366ef91fc1b7da351c588d1827f/0/conanmanifest.txt"
}

응답의 URL는 요청에 사용된 동일한 경로 접두사를 가지고 있습니다. 프로젝트 수준 경로로 요청하면 반환된 URL에 /projects/:id가 포함됩니다.

레시피 다운로드 URL

레시피 다운로드 URL은 관련 다운로드 URL이 있는 레시피 파일 이름 목록을 반환합니다.

이 속성은 레시피 매니페스트 엔드포인트와 동일한 페이로드입니다.

GET <route-prefix>/conans/:package_name/:package_version/:package_username/:package_channel/download_urls
속성 유형 필수 설명
package_name string 패키지의 이름입니다.
package_version string 패키지의 버전입니다.
package_username string 패키지의 Conan 사용자 이름입니다. 이 속성은 프로젝트의 +로 구분된 전체 경로입니다.
package_channel string 패키지의 채널입니다.
curl --header "Authorization: Bearer <authenticate_token>" "https://gitlab.example.com/api/v4/packages/conan/v1/conans/my-package/1.0/my-group+my-project/stable/digest"

예시 응답:

{
  "conan_sources.tgz": "https://gitlab.example.com/api/v4/packages/conan/v1/files/my-package/1.0/my-group+my-project/stable/0/export/conan_sources.tgz",
  "conanfile.py": "https://gitlab.example.com/api/v4/packages/conan/v1/files/my-package/1.0/my-group+my-project/stable/0/export/conanfile.py",
  "conanmanifest.txt": "https://gitlab.example.com/api/v4/packages/conan/v1/files/my-package/1.0/my-group+my-project/stable/0/export/conanmanifest.txt"
}

응답의 URL은 요청에 사용된 동일한 경로 접두사를 가지고 있습니다.

프로젝트 수준 경로로 요청하면 반환된 URL에는 /projects/:id가 포함됩니다.

패키지 다운로드 URL

패키지 다운로드 URL은 관련 다운로드 URL이 있는 패키지 파일 이름 목록을 반환합니다.

이 URL은 패키지 매니페스트 엔드포인트와 동일한 페이로드입니다.

GET <route-prefix>/conans/:package_name/:package_version/:package_username/:package_channel/packages/:conan_package_reference/download_urls
속성 유형 필수 설명
package_name string 패키지의 이름입니다.
package_version string 패키지의 버전입니다.
package_username string 패키지의 Conan 사용자 이름입니다. 이 속성은 프로젝트의 +로 구분된 전체 경로입니다.
package_channel string 패키지의 채널입니다.
conan_package_reference string Conan 패키지의 참조 해시입니다. Conan이 이 값을 생성합니다.
curl --header "Authorization: Bearer <authenticate_token>" "https://gitlab.example.com/api/v4/packages/conan/v1/conans/my-package/1.0/my-group+my-project/stable/packages/103f6067a947f366ef91fc1b7da351c588d1827f/download_urls"

예시 응답:

{
  "conan_package.tgz": "https://gitlab.example.com/api/v4/packages/conan/v1/files/my-package/1.0/my-group+my-project/stable/packages/103f6067a947f366ef91fc1b7da351c588d1827f/0/conan_package.tgz",
  "conaninfo.txt": "https://gitlab.example.com/api/v4/packages/conan/v1/files/my-package/1.0/my-group+my-project/stable/packages/103f6067a947f366ef91fc1b7da351c588d1827f/0/conaninfo.txt",
  "conanmanifest.txt": "https://gitlab.example.com/api/v4/packages/conan/v1/files/my-package/1.0/my-group+my-project/stable/packages/103f6067a947f366ef91fc1b7da351c588d1827f/0/conanmanifest.txt"
}

응답의 URL은 요청에 사용된 동일한 경로 접두사를 가지고 있습니다.

프로젝트 수준 경로로 요청하면 반환된 URL에는 /projects/:id가 포함됩니다.

레시피 업로드 URL

레시피 파일 이름과 파일 크기의 목록이 주어지면 각 파일을 업로드할 URL 목록이 반환됩니다.

POST <route-prefix>/conans/:package_name/:package_version/:package_username/:package_channel/upload_urls
속성 유형 필수 설명
package_name string 패키지의 이름입니다.
package_version string 패키지의 버전입니다.
package_username string 패키지의 Conan 사용자 이름입니다. 이 속성은 프로젝트의 +로 구분된 전체 경로입니다.
package_channel string 패키지의 채널입니다.

예제 요청 JSON 페이로드:

{
  "conanfile.py": 410,
  "conanmanifest.txt": 130
}
curl --request POST \
     --header "Authorization: Bearer <authenticate_token>" \
     --header "Content-Type: application/json" \
     --data '{"conanfile.py":410,"conanmanifest.txt":130}' \
     "https://gitlab.example.com/api/v4/packages/conan/v1/conans/my-package/1.0/my-group+my-project/stable/upload_urls"

예제 응답:

{
  "conanfile.py": "https://gitlab.example.com/api/v4/packages/conan/v1/files/my-package/1.0/my-group+my-project/stable/0/export/conanfile.py",
  "conanmanifest.txt": "https://gitlab.example.com/api/v4/packages/conan/v1/files/my-package/1.0/my-group+my-project/stable/0/export/conanmanifest.txt"
}

응답의 URL은 요청에 사용된 것과 같은 경로 접두사를 가지고 있습니다. 프로젝트 수준 경로로 요청할 경우 반환된 URL에는 /projects/:id가 포함됩니다.

패키지 업로드 URL

패키지 파일 이름과 파일 크기의 목록이 주어지면 각 파일을 업로드할 URL 목록이 반환됩니다.

POST <route-prefix>/conans/:package_name/:package_version/:package_username/:package_channel/packages/:conan_package_reference/upload_urls
속성 유형 필수 설명
package_name string 패키지의 이름입니다.
package_version string 패키지의 버전입니다.
package_username string 패키지의 Conan 사용자 이름입니다. 이 속성은 프로젝트의 +로 구분된 전체 경로입니다.
package_channel string 패키지의 채널입니다.
conan_package_reference string Conan 패키지의 참조 해시입니다. Conan이 이 값을 생성합니다.

예제 요청 JSON 페이로드:

{
  "conan_package.tgz": 5412,
  "conanmanifest.txt": 130,
  "conaninfo.txt": 210
}
curl --request POST \
     --header "Authorization: Bearer <authenticate_token>" \
     --header "Content-Type: application/json" \
     --data '{"conan_package.tgz":5412,"conanmanifest.txt":130,"conaninfo.txt":210}'
     "https://gitlab.example.com/api/v4/packages/conan/v1/conans/my-package/1.0/my-group+my-project/stable/packages/103f6067a947f366ef91fc1b7da351c588d1827f/upload_urls"

예제 응답:

{
  "conan_package.tgz": "https://gitlab.example.com/api/v4/packages/conan/v1/files/my-package/1.0/my-group+my-project/stable/0/package/103f6067a947f366ef91fc1b7da351c588d1827f/0/conan_package.tgz",
  "conanmanifest.txt": "https://gitlab.example.com/api/v4/packages/conan/v1/files/my-package/1.0/my-group+my-project/stable/0/package/103f6067a947f366ef91fc1b7da351c588d1827f/0/conanmanifest.txt",
  "conaninfo.txt": "https://gitlab.example.com/api/v4/packages/conan/v1/files/my-package/1.0/my-group+my-project/stable/0/package/103f6067a947f366ef91fc1b7da351c588d1827f/0/conaninfo.txt"
}

응답의 URL은 요청에 사용된 것과 같은 경로 접두사를 가지고 있습니다. 프로젝트 수준 경로로 요청할 경우 반환된 URL에는 /projects/:id가 포함됩니다.

레시피 파일 다운로드

패키지 레지스트리에 레시피 파일을 다운로드합니다.

레시피 다운로드 URL 엔드포인트가 반환한 다운로드 URL을 사용해야 합니다.

GET packages/conan/v1/files/:package_name/:package_version/:package_username/:package_channel/:recipe_revision/export/:file_name
속성 유형 필수 설명
package_name string 패키지의 이름.
package_version string 패키지의 버전.
package_username string 패키지의 Conan 사용자 이름. 이 속성은 프로젝트의 +로 구분된 전체 경로입니다.
package_channel string 패키지의 채널.
recipe_revision string 레시피의 리비전. GitLab은 아직 Conan 리비전을 지원하지 않으므로 기본값 0이 항상 사용됩니다.
file_name string 요청된 파일의 이름 및 파일 확장자.
curl --header "Authorization: Bearer <authenticate_token>" "https://gitlab.example.com/api/v4/packages/conan/v1/files/my-package/1.0/my-group+my-project/stable/0/export/conanfile.py"

출력 내용을 파일에 작성하려면 다음을 사용할 수 있습니다:

curl --header "Authorization: Bearer <authenticate_token>" "https://gitlab.example.com/api/v4/packages/conan/v1/files/my-package/1.0/my-group+my-project/stable/0/export/conanfile.py" >> conanfile.py

이 예제는 현재 디렉토리에 conanfile.py로 작성합니다.

레시피 파일 업로드

패키지 레지스트리에 레시피 파일을 업로드합니다.

레시피 업로드 URL 엔드포인트가 반환한 업로드 URL을 사용해야 합니다.

PUT packages/conan/v1/files/:package_name/:package_version/:package_username/:package_channel/:recipe_revision/export/:file_name
속성 유형 필수 설명
package_name string 패키지의 이름.
package_version string 패키지의 버전.
package_username string 패키지의 Conan 사용자 이름. 이 속성은 프로젝트의 +로 구분된 전체 경로입니다.
package_channel string 패키지의 채널.
recipe_revision string 레시피의 리비전. GitLab은 아직 Conan 리비전을 지원하지 않으므로 기본값 0이 항상 사용됩니다.
file_name string 요청된 파일의 이름 및 파일 확장자.

요청 본문에 파일 내용을 제공하십시오:

curl --request PUT \
     --user <username>:<personal_access_token> \
     --upload-file path/to/conanfile.py \
     "https://gitlab.example.com/api/v4/packages/conan/v1/files/my-package/1.0/my-group+my-project/stable/0/export/conanfile.py"

패키지 파일 다운로드

패키지 레지스트리에 패키지 파일을 다운로드합니다.

패키지 다운로드 URL 엔드포인트가 반환한 다운로드 URL을 사용해야 합니다.

GET packages/conan/v1/files/:package_name/:package_version/:package_username/:package_channel/:recipe_revision/package/:conan_package_reference/:package_revision/:file_name
속성 유형 필수 설명
package_name string 패키지의 이름.
package_version string 패키지의 버전.
package_username string 패키지의 Conan 사용자 이름. 이 속성은 프로젝트의 +로 구분된 전체 경로입니다.
package_channel string 패키지의 채널.
recipe_revision string 레시피의 리비전. GitLab은 아직 Conan 리비전을 지원하지 않으므로 기본값 0이 항상 사용됩니다.
conan_package_reference string Conan 패키지의 참조 해시. Conan이 이 값을 생성합니다.
package_revision string 패키지의 리비전. GitLab은 아직 Conan 리비전을 지원하지 않으므로 기본값 0이 항상 사용됩니다.
file_name string 요청된 파일의 이름 및 파일 확장자.
curl --header "Authorization: Bearer <authenticate_token>" "https://gitlab.example.com/api/v4/packages/conan/v1/files/my-package/1.0/my-group+my-project/stable/packages/103f6067a947f366ef91fc1b7da351c588d1827f/0/conaninfo.txt"

출력 내용을 파일에 작성하려면 다음을 사용할 수 있습니다:

curl --header "Authorization: Bearer <authenticate_token>" "https://gitlab.example.com/api/v4/packages/conan/v1/files/my-package/1.0/my-group+my-project/stable/packages/103f6067a947f366ef91fc1b7da351c588d1827f/0/conaninfo.txt" >> conaninfo.txt

이 예제는 현재 디렉토리에 conaninfo.txt로 작성합니다.

패키지 파일 업로드

패키지 레지스트리에 패키지 파일을 업로드합니다.

패키지 업로드 URL 엔드포인트에서 반환된 업로드 URL을 사용해야 합니다.

PUT packages/conan/v1/files/:package_name/:package_version/:package_username/:package_channel/:recipe_revision/package/:conan_package_reference/:package_revision/:file_name
속성 유형 필수 설명
package_name string 패키지의 이름입니다.
package_version string 패키지의 버전입니다.
package_username string 패키지의 Conan 사용자 이름입니다. 이 속성은 당신의 프로젝트의 +로 구분된 전체 경로입니다.
package_channel string 패키지의 채널입니다.
recipe_revision string 레시피의 수정입니다. GitLab은 아직 Conan 수정 사항을 지원하지 않으므로 기본 값 0이 항상 사용됩니다.
conan_package_reference string Conan 패키지의 참조 해시입니다. Conan이 이 값을 생성합니다.
package_revision string 패키지의 수정입니다. GitLab은 아직 Conan 수정 사항을 지원하지 않으므로 기본 값 0이 항상 사용됩니다.
file_name string 요청된 파일의 이름 및 파일 확장자입니다.

요청 본문에 파일 컨텍스트를 제공합니다:

curl --request PUT \
     --user <username>:<personal_access_token> \
     --upload-file path/to/conaninfo.txt \
     "https://gitlab.example.com/api/v4/packages/conan/v1/files/my-package/1.0/my-group+my-project/stable/0/package/103f6067a947f366ef91fc1b7da351c588d1827f/0/conaninfo.txt"

패키지 삭제 (Conan 레시피 삭제)

레지스트리에서 Conan 레시피 및 패키지 파일을 삭제합니다:

DELETE <route-prefix>/conans/:package_name/:package_version/:package_username/:package_channel
속성 유형 필수 설명
package_name string 패키지의 이름입니다.
package_version string 패키지의 버전입니다.
package_username string 패키지의 Conan 사용자 이름입니다. 이 속성은 당신의 프로젝트의 +로 구분된 전체 경로입니다.
package_channel string 패키지의 채널입니다.
curl --request DELETE --header "Authorization: Bearer <authenticate_token>" "https://gitlab.example.com/api/v4/packages/conan/v1/conans/my-package/1.0/my-group+my-project/stable"

예시 응답:

{
  "id": 1,
  "project_id": 123,
  "created_at": "2020-08-19T13:17:28.655Z",
  "updated_at": "2020-08-19T13:17:28.655Z",
  "name": "my-package",
  "version": "1.0",
  "package_type": "conan",
  "creator_id": null,
  "status": "default"
}