plaintext # Conan API

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

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

경고: 이 API는 Conan 패키지 매니저 클라이언트에서 사용되며 일반적으로 수동으로 사용할 목적이 아닙니다.

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

참고: 이 엔드포인트들은 표준 API 인증 방법을 준수하지 않습니다. 크리덴셜이 어떻게 전달되어야 하는지에 대한 자세한 내용은 각 라우트를 참조하십시오. 문서화되지 않은 인증 방법은 향후에 제거될 수 있습니다.

참고: Conan 레지스트리는 FIPS(연방 정보 처리 표준) 준수가 되지 않으며 FIPS 모드가 활성화될 때 비활성화됩니다. 이러한 엔드포인트들은 모두 404 Not Found를 반환합니다.

라우트 프리픽스

다음과 같이 서로 다른 범위에서 요청을 수행하는 두 세트의 동일한 라우트가 있습니다:

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

이 문서의 예제는 모두 인스턴스 수준의 프리픽스를 사용합니다.

인스턴스 수준

/packages/conan/v1

인스턴스 수준 라우트를 사용할 때에는 Conan 레시피에 대한 네이밍 제한이 있음을 유의하십시오.

프로젝트 수준

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

GitLab Conan 레지스트리에 대한 가용성을 확인하기 위해 핑을 보냅니다:

GET <라우트-프리픽스>/ping
curl "https://gitlab.example.com/api/v4/packages/conan/v1/ping"

예시 응답:

""

검색

이름으로 인스턴스에서 Conan 패키지를 검색합니다:

GET <라우트-프리픽스>/conans/search
속성 유형 필수 설명
q 문자열 검색 쿼리. 와일드카드로 *를 사용할 수 있습니다.
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"
  ]
}

인증

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

"Authorization: Bearer <token>

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

GET <라우트-프리픽스>/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 <라우트-프리픽스>/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 <라우트-프리픽스>/conans/:package_name/:package_version/:package_username/:package_channel
속성 유형 필수 설명
package_name 문자열 패키지 이름.
package_version 문자열 패키지 버전.
package_username 문자열 패키지의 Conan 사용자 이름. 이 속성은 프로젝트의 +로 구분된 전체 경로입니다.
package_channel 문자열 패키지의 채널.
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을 가진 레시피 파일 이름의 목록을 반환합니다. 이 속성은 recipe manifest 엔드포인트와 동일한 페이로드입니다.

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 문자열 패키지 이름
package_version 문자열 패키지 버전
package_username 문자열 패키지의 Conan 사용자 이름. 이 속성은 프로젝트의 +로 구분된 전체 경로입니다.
package_channel 문자열 패키지 채널
recipe_revision 문자열 레시피의 수정 번호. GitLab은 아직 Conan 수정 번호를 지원하지 않으므로 기본값 0을 항상 사용합니다.
file_name 문자열 요청한 파일의 이름과 확장자
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 문자열 패키지 이름
package_version 문자열 패키지 버전
package_username 문자열 패키지의 Conan 사용자 이름. 이 속성은 프로젝트의 +로 구분된 전체 경로입니다.
package_channel 문자열 패키지 채널
recipe_revision 문자열 레시피의 수정 번호. GitLab은 아직 Conan 수정 번호를 지원하지 않으므로 기본값 0을 항상 사용합니다.
file_name 문자열 요청한 파일의 이름과 확장자

요청 본문에 파일 콘텐츠를 제공하십시오:

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 문자열 패키지 이름
package_version 문자열 패키지 버전
package_username 문자열 패키지의 Conan 사용자 이름. 이 속성은 프로젝트의 +로 구분된 전체 경로입니다.
package_channel 문자열 패키지 채널
recipe_revision 문자열 레시피의 수정 번호. GitLab은 아직 Conan 수정 번호를 지원하지 않으므로 기본값 0을 항상 사용합니다.
conan_package_reference 문자열 Conan 패키지의 참조 해시. Conan이 이 값을 생성합니다.
package_revision 문자열 패키지의 수정 번호. GitLab은 아직 Conan 수정 번호를 지원하지 않으므로 기본값 0을 항상 사용합니다.
file_name 문자열 요청한 파일의 이름과 확장자
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 문자열 패키지 이름
package_version 문자열 패키지 버전
package_username 문자열 패키지의 Conan 사용자 이름. 이 속성은 프로젝트의 +로 구분된 전체 경로입니다.
package_channel 문자열 패키지 채널
recipe_revision 문자열 레시피의 수정 번호. GitLab은 아직 Conan 수정 번호를 지원하지 않으므로 기본값 0을 항상 사용합니다.
conan_package_reference 문자열 Conan 패키지의 참조 해시. Conan이 이 값을 생성합니다.
package_revision 문자열 패키지의 수정 번호. GitLab은 아직 Conan 수정 번호를 지원하지 않으므로 기본값 0을 항상 사용합니다.
file_name 문자열 요청한 파일의 이름과 확장자

요청 본문에 파일 콘텐츠를 제공하십시오:

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"
}