このページは Apigee と Apigee ハイブリッドに適用されます。
このドキュメントでは、登録済み API 間の依存関係を作成および管理する方法について説明します。依存関係は、API 間の関係を把握するのに役立ちます。依存関係の概要をご覧ください。
依存関係を作成する
依存関係エンティティは、REST API を使用して作成できます。
REST
依存関係の作成 API を使用して新しい依存関係を作成するには:
curl -X POST 'https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/dependencies?dependency_id=DEPENDENCY_ID' \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H 'Content-Type: application/json' \
--d '{
"description": "DESCRIPTION",
"supplier": {
// Specify one of the following:
"operation_resource_name": RESOURCE_NAME
// OR
"external_resource_name: RESOURCE_NAME"
},
"consumer": {
// Specify one of the following:
"operation_resource_name": RESOURCE_NAME
// OR
"external_resource_name: RESOURCE_NAME"
}
}'
次のように置き換えます。
- HUB_PROJECT: API Hub のホスト プロジェクトの名前。このホスト プロジェクトは API Hub のプロビジョニング時に選択されたものです。
- HUB_LOCATION: ホスト プロジェクトの場所。この場所は API Hub のプロビジョニング時に選択されたものです。
- DEPENDENCY_ID:（省略可）依存関係の識別子。指定しない場合、システムで生成された ID が使用されます。名前は 4～500 文字の文字列にする必要があり、有効な文字は
/[a-z][A-Z][0-9]-_.です。 - DESCRIPTION:（省略可）依存関係の簡単な説明。
RESOURCE_NAME:（必須）指定する属性に応じて、API Hub または外部 API のオペレーションのリソース名。
オペレーションのリソース名の形式は
projects/PROJECT/locations/LOCATION/apis/API/versions/VERSION/operations/OPERATIONです。オペレーションのリソースの例:
"projects/myproject/locations/us-central1/apis/payments-api/versions/locationv1/operations/getlocation"外部 API リソース名の形式は
projects/PROJECT/locations/LOCATION/externalApis/EXTERNAL_APIです。外部 API リソースの例:
"projects/myproject/locations/us-central1/externalApis/petstore"
レスポンスの例:
{
"name": "projects/myproject/locations/us-central1/dependencies/user-to-pet",
"consumer": {
"displayName": "POST - /v2/user",
"operationResourceName": "projects/myproject/locations/us-central1/apis/payments-api/versions/version1/operations/createuser"
},
"supplier": {
"displayName": "POST - /v2/pet",
"operationResourceName": "projects/myproject/locations/us-central1/apis/payments-api/versions/version1/operations/addpet"
},
"state": "VALIDATED",
"description": "Dependency from user to pet API",
"discoveryMode": "MANUAL",
"createTime": "2024-04-17T19:33:31.664226Z",
"updateTime": "2024-04-17T19:33:31.664226Z"
}
REST の例
curl -X POST 'https://apihub.googleapis.com/v1/projects/myproject/locations/us-central1/dependencies?dependency_id=user-to-pet' \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H 'Content-Type: application/json' \
--d '{
"description": "Dependency from user to pet API",
"consumer": {
"operation_resource_name": "projects/myproject/locations/us-central1/apis/payments-api/versions/paymentv1/operations/createuser"
},
"supplier": {
"operation_resource_name": "projects/myproject/locations/us-central1/apis/pet-api/versions/petstorev1/operations/addpet"
}
}'
依存関係を一覧表示する
このセクションでは、依存関係を一覧表示する方法について説明します。ある特定の API のすべてのバージョンに関連付けられたすべての依存関係を一覧表示できるほか、特定のバージョンに関連付けられたすべての依存関係を一覧表示することもできます。
REST
すべての依存関係を一覧表示するには、依存関係の一覧表示 API を使用します。
curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/dependencies"
-H "Authorization: Bearer: $(gcloud auth print-access-token)" -X GET -H "Content-Type: application/json"
次のように置き換えます。
- HUB_PROJECT: API Hub のホスト プロジェクトの名前。このホスト プロジェクトは API Hub のプロビジョニング時に選択されたものです。
- HUB_LOCATION: ホスト プロジェクトの場所。この場所は API Hub のプロビジョニング時に選択されたものです。
出力例:
{
"dependencies": [
{
"name": "projects/myproject/locations/us-central1/dependencies/user-to-pet",
"consumer": {
"displayName": "POST - /v2/user",
"operationResourceName": "projects/myproject/locations/us-central1/apis/payments-api/versions/version1/operations/createuser"
},
"supplier": {
"displayName": "POST - /v2/pet",
"operationResourceName": "projects/myproject/locations/us-central1/apis/payments-api/versions/version1/operations/addpet"
}
}
]
}
依存関係の詳細を取得する
このセクションでは、REST API を使用して API の依存関係の詳細を取得する方法について説明します。
REST
依存関係の詳細を表示するには、依存関係の詳細の取得 API を使用します。
curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/dependencies/DEPENDENCY_ID" -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X GET -H "Content-Type: application/json"
次のように置き換えます。
- HUB_PROJECT: API Hub のホスト プロジェクトの名前。このホスト プロジェクトは API Hub のプロビジョニング時に選択されたものです。
- HUB_LOCATION: ホスト プロジェクトの場所。この場所は API Hub のプロビジョニング時に選択されたものです。
- DEPENDENCY_ID: 依存関係の一意の ID。
レスポンスの例:
{
"name": "projects/myproject/locations/us-central1/dependencies/user-to-pet",
"consumer": {
"displayName": "POST - /v2/user",
"operationResourceName": "projects/myproject/locations/us-central1/apis/payments-api/versions/version1/operations/createuser"
},
"supplier": {
"displayName": "POST - /v2/pet",
"operationResourceName": "projects/myproject/locations/us-central1/apis/payments-api/versions/version1/operations/addpet"
},
"state": "VALIDATED",
"description": "Dependency from user to pet API",
"discoveryMode": "MANUAL",
"createTime": "2024-04-17T19:33:31.215978712Z",
"updateTime": "2024-04-17T19:33:31.737505297Z"
}
API の依存関係を削除する
このセクションでは、API の依存関係を削除する方法について説明します。
REST
API Hub から依存関係を削除するには、依存関係の削除 API を使用します。
curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/dependencies/DEPENDENCY_ID" -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X DELETE -H "Content-Type: application/json"
次のように置き換えます。
- HUB_PROJECT: API Hub のホスト プロジェクトの名前。このホスト プロジェクトは API Hub のプロビジョニング時に選択されたものです。
- HUB_LOCATION: ホスト プロジェクトの場所。この場所は API Hub のプロビジョニング時に選択されたものです。
- DEPENDENCY_ID: 削除する依存関係の ID。
依存関係を編集する
このセクションでは、依存関係を編集する方法について説明します。編集可能な属性は description のみです。
REST
デプロイメントを編集するには、依存関係へのパッチの適用 API を使用します。
curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/dependencies/DEPENDENCY_ID"
-H "Authorization: Bearer: $(gcloud auth print-access-token)" -X PATCH -H "Content-Type: application/json"
'{
'description': DESCRIPTION
{'
次のように置き換えます。
- HUB_PROJECT: API Hub のホスト プロジェクトの名前。このホスト プロジェクトは API Hub のプロビジョニング時に選択されたものです。
- HUB_LOCATION: ホスト プロジェクトの場所。この場所は API Hub のプロビジョニング時に選択されたものです。
- DEPLOYMENT_ID: 編集するデプロイメントの ID。
- DESCRIPTION: 編集可能な属性は description のみです。