Abhängigkeiten verwalten

Diese Seite gilt für Apigee und Apigee Hybrid.

In diesem Dokument wird beschrieben, wie Sie Abhängigkeiten zwischen registrierten APIs erstellen und verwalten. Abhängigkeiten helfen Ihnen, die Beziehungen zwischen APIs zu erkennen. Siehe Einführung in Abhängigkeiten.

Abhängigkeit erstellen

Sie können mit der REST API eine Abhängigkeitsentität erstellen.

REST

So erstellen Sie eine neue Abhängigkeit mithilfe der API Abhängigkeit erstellen:

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": {
          "operation_resource_name": SUPPLIER_OPERATION
      },
      "consumer": {
          "operation_resource_name": CONSUMER_OPERATION
      }
  }'

Ersetzen Sie Folgendes:

HUB_PROJECT ist der Name des API-Hub-Hostprojekts. Das Hostprojekt wurde bei der Bereitstellung des API-Hubs ausgewählt.
HUB_LOCATION: der Standort des Hostprojekts. Der Standort wurde bei der Bereitstellung des API-Hubs ausgewählt.
DEPENDENCY_ID: (Optional) Die Kennung der Abhängigkeit. Wenn nicht angegeben, wird eine vom System generierte ID verwendet. Der Name muss ein String mit 4 bis 500 Zeichen sein, wobei gültige Zeichen /[a-z][A-Z][0-9]-_. sind.
DESCRIPTION: (Optional) Eine kurze Beschreibung der Abhängigkeit.
SUPPLIER_OPERATION: (Erforderlich) Der vollständig qualifizierte Name des Lieferantenvorgangs. Beispiel: "projects/myproject/locations/us-central1/apis/payments-api/versions/locationv1/operations/getlocation"
CONSUMER_OPERATION: (Erforderlich) Der vollständig qualifizierte Name des Nutzervorgangs. Dieser Vorgang hängt vom Anbietervorgang ab (ruft ihn auf). Beispiel: "projects/myproject/locations/us-central1/apis/payments-api/versions/locationv1/operations/createuser"

Beispielantwort:

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

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

Abhängigkeiten auflisten

In diesem Abschnitt wird erläutert, wie Sie die Abhängigkeiten auflisten. Sie können alle Abhängigkeiten auflisten, die mit allen Versionen einer API verknüpft sind, oder alle Abhängigkeiten auflisten, die einer bestimmten Version zugeordnet sind.

REST

Verwenden Sie die API Abhängigkeiten auflisten, um alle Abhängigkeiten aufzulisten:

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"

Ersetzen Sie Folgendes:

HUB_PROJECT ist der Name des API-Hub-Hostprojekts. Das Hostprojekt wurde bei der Bereitstellung des API-Hubs ausgewählt.
HUB_LOCATION: der Standort des Hostprojekts. Der Standort wurde bei der Bereitstellung des API-Hubs ausgewählt.

Beispielausgabe:

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

Abhängigkeitsdetails abrufen

In diesem Abschnitt wird erläutert, wie Sie Details zu einer API-Abhängigkeit mit der REST API abrufen.

REST

Mit der API zum Abrufen von Abhängigkeitsdetails können Sie Details zu einer Abhängigkeit aufrufen:

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"

Ersetzen Sie Folgendes:

HUB_PROJECT ist der Name des API-Hub-Hostprojekts. Das Hostprojekt wurde bei der Bereitstellung des API-Hubs ausgewählt.
HUB_LOCATION: der Standort des Hostprojekts. Der Standort wurde bei der Bereitstellung des API-Hubs ausgewählt.
DEPENDENCY_ID: Die eindeutige ID der Abhängigkeit.

Beispielantwort:

{
  "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-Abhängigkeit löschen

In diesem Abschnitt wird gezeigt, wie Sie eine API-Abhängigkeit löschen.

REST

Verwenden Sie die API Abhängigkeit löschen, um eine Abhängigkeit aus dem API-Hub zu löschen:

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"

Ersetzen Sie Folgendes:

HUB_PROJECT ist der Name des API-Hub-Hostprojekts. Das Hostprojekt wurde bei der Bereitstellung des API-Hubs ausgewählt.
HUB_LOCATION: der Standort des Hostprojekts. Der Standort wurde bei der Bereitstellung des API-Hubs ausgewählt.
DEPENDENCY_ID: Die ID der zu löschenden Abhängigkeit.

Abhängigkeit bearbeiten

In diesem Abschnitt wird erläutert, wie Sie eine Abhängigkeit bearbeiten. Das einzige bearbeitbare Attribut ist die Beschreibung.

REST

Verwenden Sie zum Bearbeiten einer Bereitstellung die API Abhängigkeit patchen:

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
    {'

Ersetzen Sie Folgendes:

HUB_PROJECT ist der Name des API-Hub-Hostprojekts. Das Hostprojekt wurde bei der Bereitstellung des API-Hubs ausgewählt.
HUB_LOCATION: der Standort des Hostprojekts. Der Standort wurde bei der Bereitstellung des API-Hubs ausgewählt.
DEPLOYMENT_ID: ID des zu bearbeitenden Deployments.
DESCRIPTION: Das einzige bearbeitbare Attribut ist die Beschreibung.