Einführung in Abhängigkeiten

Diese Seite gilt für Apigee und Apigee Hybrid.

Vorschau — Apigee API hub

Diese Funktion unterliegt den „Nutzungsbedingungen für Pre-GA-Angebote“ im Abschnitt „Allgemeine Nutzungsbedingungen“ der dienstspezifischen Nutzungsbedingungen. Pre-GA-Funktionen sind „wie besehen“ verfügbar und werden möglicherweise nur eingeschränkt unterstützt. Weitere Informationen finden Sie in den Beschreibungen der Startphase.

Mit API-Hub-Abhängigkeiten können Sie die Beziehungen zwischen API-Vorgängen sehen und verwalten. Wenn Sie die Abhängigkeiten einer API finden und verfolgen, können Sie Ihre API-Umgebung effizienter verwalten. Mit Abhängigkeiten können Sie beispielsweise die potenziellen Auswirkungen der Änderung oder Einstellung einer API erkennen, Probleme beheben oder die Einhaltung von Kosten- oder Compliancevorschriften analysieren. Die APIs können im API-Hub oder außerhalb des API-Hubs gespeichert werden.

Was ist eine Abhängigkeit?

API-Hub modelliert eine Abhängigkeit als gerichtete Beziehung zwischen API-Vorgängen, wobei ein API-Vorgang der Anbieter und der andere der Nutzer ist. Angenommen, die PetStore API ruft einen Vorgang in der Location API auf. In diesem Fall ist die PetStore API von einem Vorgang abhängig, der von der Location API bereitgestellt wird. Im API-Hub bezeichnen wir PetStore als Nutzer und Standort als Anbieter.

Hinweis: In der Vorschauversion unterstützt der API-Hub Abhängigkeiten basierend auf API-Vorgängen oder externen APIs (APIs, die nicht im API-Hub gespeichert sind). Sie können beim Erstellen der Abhängigkeit auswählen, welche Art von Abhängigkeit ist.

Abbildung 1 veranschaulicht die Anbieter/Nutzer-Beziehung zwischen API-Vorgängen. Der Vorgang /debit der Payment API nutzt den Vorgang /detect der Fraud Detection API. Der Abbuchungsvorgang ist der Nutzer und der Betrugserkennungsvorgang ist der Anbieter in dieser Beziehung.

Ebenso nutzt /detect-Vorgänge, die von der UserProfile API und der GeoLocation API bereitgestellt werden. In diesem Fall ist der /detect-Vorgang der Nutzer und die anderen beiden sind die Anbieter.

Abbildung 1. Zuordnung von API-Abhängigkeiten

Abhängigkeit erstellen

Die grundlegenden Schritte zum Erstellen einer Abhängigkeit im API-Hub sind:

1. Suchen Sie zwei APIs mit möglichen Abhängigkeiten, die Sie verfolgen möchten.
2. Mit der List Versions API können Sie die Versionen der beiden APIs auflisten. Alternativ können Sie die List Operations API verwenden und die Ergebnisse filtern, um abhängige Vorgänge zu finden.
3. Bestimmen Sie, welcher Vorgang der Anbieter und welcher der Verbraucher ist. Wie bereits erwähnt, ruft der Nutzervorgang einen Vorgang vom Lieferanten auf.
4. Verwenden Sie die Create Dependency API, um die Abhängigkeit zwischen dem Lieferantenvorgang und dem Nutzervorgang zu erstellen.

Weitere Informationen zum Aufrufen der Create Dependency API und ein Beispiel finden Sie unter Create Dependency API.

Abhängigkeiten suchen

Die List Dependency API ist eine gute Möglichkeit, Abhängigkeiten im API-Hub zu finden. Mit der API können Sie nach Schlüsselattributen filtern, einschließlich des Namens des Quellvorgangs, des Namens des Zielvorgangs und des Status der Abhängigkeit.

Die grundlegenden Schritte zum Suchen von Abhängigkeiten sind:

1. Mit der List Dependency API können Sie alle Abhängigkeiten auflisten oder die Filterfunktion der API nutzen, um die Suche einzugrenzen.
2. Mit der Get Dependency API können Sie die fehlerhaften Abhängigkeiten aufschlüsseln und weitere Details wie den Lieferantennamen ermitteln.

Hier ist ein Beispiel für einen API-Aufruf zum Auflisten von Abhängigkeiten:

curl "https://apihub.googleapis.com/v1/projects/myproject/locations/us-central1/dependencies"
    -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X GET -H "Content-Type: application/json"

Fehlerhafte Abhängigkeiten identifizieren

So ermitteln Sie fehlerhafte Abhängigkeiten:

1. Mit der List Dependency API können Sie alle Abhängigkeiten auflisten oder die Filterfunktion der API nutzen, um die Suche einzugrenzen.
2. Ermitteln Sie, für welche der zurückgegebenen Abhängigkeiten ein Fehler-Flag festgelegt ist.
3. Mit der Get Dependency API können Sie die fehlerhaften Abhängigkeiten aufschlüsseln und weitere Details wie den Lieferantennamen ermitteln.

   Hier sehen Sie eine Beispielantwort, in der die Fehlerbedingung anzeigt, dass der Lieferantenvorgang entfernt wurde:

   {
     "name": "projects/common-dev-15/locations/us-central1/dependencies/user-to-pet",
     "consumer": {
         "displayName": "POST - /v2/user",
         "operationResourceName": "projects/common-dev-15/locations/us-central1/apis/payments-api/versions/2ff89c88-e8b6-48c4-a1c2-bdbb2a929bde/operations/createuser"
     },
     "supplier": {
         "displayName": "POST - /v2/pet",
         "operationResourceName": "projects/common-dev-15/locations/us-central1/apis/payments-api/versions/2ff89c88-e8b6-48c4-a1c2-bdbb2a929bde/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",
     {
       "error": "SUPPLIER_NOT_FOUND",
       "errorTime": 2024-05-18T20:23:42.465324Z
     }
   }

Andere Abhängigkeitsvorgänge

Nachdem Sie eine Abhängigkeit erstellt haben, können Sie API-Hub-APIs verwenden, um Details zu einer Abhängigkeit abzurufen, Abhängigkeiten zu ermitteln, indem Sie eine Liste aller Abhängigkeiten im API-Hub filtern, eine Abhängigkeit löschen und die Beschreibung einer Abhängigkeit aktualisieren. Alle Dependency APIs werden in der API-Referenz und unter Abhängigkeiten verwalten ausführlich beschrieben.