正式なドキュメントは英語版であり、この日本語訳はAI支援翻訳により作成された参考用のものです。日本語訳の一部の内容は人間によるレビューがまだ行われていないため、翻訳のタイミングにより英語版との間に差異が生じることがあります。最新かつ正確な情報については、英語版をご参照ください。

Composer API

  • プラン: Free、Premium、Ultimate
  • 提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated

このAPIを使用して、Composerパッケージマネージャークライアントと対話します。

このAPIはComposerパッケージマネージャークライアントによって使用され、通常は手動での利用を意図していません。

これらのエンドポイントは、標準のAPI認証方法に準拠していません。サポートされているヘッダーとトークンのタイプに関する詳細は、Composerパッケージレジストリドキュメントを参照してください。記載されていない認証方法は、将来削除される可能性があります。

リポジトリURLテンプレートを取得する

グループの個々のパッケージをリクエストするための、リポジトリURLテンプレートを取得する。

GET group/:id/-/packages/composer/packages
属性型必須説明
id文字列はいグループのIDまたは完全なパス。
curl --user <username>:<personal_access_token> \
  --url "https://gitlab.example.com/api/v4/group/1/-/packages/composer/packages"

レスポンス例:

{
  "packages": [],
  "metadata-url": "/api/v4/group/1/-/packages/composer/p2/%package%.json",
  "provider-includes": {
    "p/%hash%.json": {
      "sha256": "082df4a5035f8725a12a4a3d2da5e6aaa966d06843d0a5c6d499313810427bd6"
    }
  },
  "providers-url": "/api/v4/group/1/-/packages/composer/%package%$%hash%.json"
}

このエンドポイントはComposer V1およびV2で使用されます。V2固有のレスポンスを確認するには、Composer User-Agentヘッダーを含めてください。Composer V2の使用をV1よりも推奨します。

curl --user <username>:<personal_access_token> \
     --header "User-Agent: Composer/2" \
     --url "https://gitlab.example.com/api/v4/group/1/-/packages/composer/packages"

レスポンス例:

{
  "packages": [],
  "metadata-url": "/api/v4/group/1/-/packages/composer/p2/%package%.json"
}

V1パッケージリスト

V1プロバイダーSHAを指定して、グループのリポジトリ内のパッケージのリストを取得する。Composer V2の使用をV1よりも推奨します。

GET group/:id/-/packages/composer/p/:sha
属性型必須説明
id文字列はいグループのIDまたは完全なパス。
sha文字列はいComposerのbase requestによって提供されるプロバイダーSHA。
curl --user <username>:<personal_access_token> \
  --url "https://gitlab.example.com/api/v4/group/1/-/packages/composer/p/082df4a5035f8725a12a4a3d2da5e6aaa966d06843d0a5c6d499313810427bd6"

レスポンス例:

{
  "providers": {
    "my-org/my-composer-package": {
      "sha256": "5c873497cdaa82eda35af5de24b789be92dfb6510baf117c42f03899c166b6e7"
    }
  }
}

V1パッケージメタデータを取得する

グループの指定されたパッケージのバージョンとメタデータのリストを取得する。Composer V2の使用をV1よりも推奨します。

GET group/:id/-/packages/composer/:package_name$:sha

URL内の$記号に注意してください。リクエストを行う場合、%24記号のURLエンコードされたバージョンが必要になる場合があります。表の後にある例を参照してください:

属性型必須説明
id文字列はいグループのIDまたは完全なパス。
package_name文字列はいパッケージ名。
sha文字列はいV1パッケージリストによって提供される、パッケージのSHAダイジェスト。
curl --user <username>:<personal_access_token> \
  --url "https://gitlab.example.com/api/v4/group/1/-/packages/composer/my-org/my-composer-package%245c873497cdaa82eda35af5de24b789be92dfb6510baf117c42f03899c166b6e7"

レスポンス例:

{
  "packages": {
    "my-org/my-composer-package": {
      "1.0.0": {
        "name": "my-org/my-composer-package",
        "type": "library",
        "license": "GPL-3.0-only",
        "version": "1.0.0",
        "dist": {
          "type": "zip",
          "url": "https://gitlab.example.com/api/v4/projects/1/packages/composer/archives/my-org/my-composer-package.zip?sha=673594f85a55fe3c0eb45df7bd2fa9d95a1601ab",
          "reference": "673594f85a55fe3c0eb45df7bd2fa9d95a1601ab",
          "shasum": ""
        },
        "source": {
          "type": "git",
          "url": "https://gitlab.example.com/my-org/my-composer-package.git",
          "reference": "673594f85a55fe3c0eb45df7bd2fa9d95a1601ab"
        },
        "uid": 1234567
      },
      "2.0.0": {
        "name": "my-org/my-composer-package",
        "type": "library",
        "license": "GPL-3.0-only",
        "version": "2.0.0",
        "dist": {
          "type": "zip",
          "url": "https://gitlab.example.com/api/v4/projects/1/packages/composer/archives/my-org/my-composer-package.zip?sha=445394f85a55fe3c0eb45df7bd2fa9d95a1601ab",
          "reference": "445394f85a55fe3c0eb45df7bd2fa9d95a1601ab",
          "shasum": ""
        },
        "source": {
          "type": "git",
          "url": "https://gitlab.example.com/my-org/my-composer-package.git",
          "reference": "445394f85a55fe3c0eb45df7bd2fa9d95a1601ab"
        },
        "uid": 1234567
      }
    }
  }
}

V2パッケージメタデータを取得する

グループの指定されたパッケージのバージョンとメタデータのリストを取得する。

GET group/:id/-/packages/composer/p2/:package_name
属性型必須説明
id文字列はいグループのIDまたは完全なパス。
package_name文字列はいパッケージ名。
curl --user <username>:<personal_access_token> \
  --url "https://gitlab.example.com/api/v4/group/1/-/packages/composer/p2/my-org/my-composer-package"

レスポンス例:

{
  "packages": {
    "my-org/my-composer-package": {
      "1.0.0": {
        "name": "my-org/my-composer-package",
        "type": "library",
        "license": "GPL-3.0-only",
        "version": "1.0.0",
        "dist": {
          "type": "zip",
          "url": "https://gitlab.example.com/api/v4/projects/1/packages/composer/archives/my-org/my-composer-package.zip?sha=673594f85a55fe3c0eb45df7bd2fa9d95a1601ab",
          "reference": "673594f85a55fe3c0eb45df7bd2fa9d95a1601ab",
          "shasum": ""
        },
        "source": {
          "type": "git",
          "url": "https://gitlab.example.com/my-org/my-composer-package.git",
          "reference": "673594f85a55fe3c0eb45df7bd2fa9d95a1601ab"
        },
        "uid": 1234567
      },
      "2.0.0": {
        "name": "my-org/my-composer-package",
        "type": "library",
        "license": "GPL-3.0-only",
        "version": "2.0.0",
        "dist": {
          "type": "zip",
          "url": "https://gitlab.example.com/api/v4/projects/1/packages/composer/archives/my-org/my-composer-package.zip?sha=445394f85a55fe3c0eb45df7bd2fa9d95a1601ab",
          "reference": "445394f85a55fe3c0eb45df7bd2fa9d95a1601ab",
          "shasum": ""
        },
        "source": {
          "type": "git",
          "url": "https://gitlab.example.com/my-org/my-composer-package.git",
          "reference": "445394f85a55fe3c0eb45df7bd2fa9d95a1601ab"
        },
        "uid": 1234567
      }
    }
  }
}

パッケージを作成する

指定されたGitタグまたはブランチから、プロジェクト用のComposerパッケージを作成します。

POST projects/:id/packages/composer
属性型必須説明
id文字列はいグループのIDまたは完全なパス。
tag文字列いいえパッケージのターゲットとなるタグの名前。
branch文字列いいえパッケージのターゲットとなるブランチの名前。
curl --request POST --user <username>:<personal_access_token> \
     --data tag=v1.0.0 \
     --url "https://gitlab.example.com/api/v4/projects/1/packages/composer"

レスポンス例:

{
  "message": "201 Created"
}

パッケージアーカイブをダウンロードする

プロジェクトの指定されたComposerパッケージアーカイブをダウンロードします。このURLは、v1またはv2パッケージメタデータレスポンスで提供されます。.zipファイル拡張子がリクエストに含まれている必要があります。

GET projects/:id/packages/composer/archives/:package_name
属性型必須説明
id文字列はいグループのIDまたは完全なパス。
package_name文字列はいパッケージ名。
sha文字列はいパッケージバージョンのターゲットSHA。
curl --user <username>:<personal_access_token> \
  --url "https://gitlab.example.com/api/v4/projects/1/packages/composer/archives/my-org/my-composer-package.zip?sha=673594f85a55fe3c0eb45df7bd2fa9d95a1601ab"

出力をファイルに書き込む:

curl --user <username>:<personal_access_token> \
  --url "https://gitlab.example.com/api/v4/projects/1/packages/composer/archives/my-org/my-composer-package.zip?sha=673594f85a55fe3c0eb45df7bd2fa9d95a1601ab" >> package.zip

これにより、ダウンロードされたファイルが現在のディレクトリのpackage.zipに書き込まれます。