OpenAPI-Spezifikation für Ihre Integration ansehen

Mit Application Integration können Sie die OpenAPI-Spezifikationen Ihrer veröffentlichten Integrationen, die mit einem oder mehreren API-Triggern konfiguriert sind, dynamisch generieren und ansehen. Wenn Sie auf die OpenAPI-Spezifikation Ihrer Integration zugreifen, haben Sie folgende Möglichkeiten:

Verschaffen Sie sich einen umfassenden Überblick über die API-Endpunkte, Methoden und Datenstrukturen Ihrer Integration.
Eine detaillierte und zentrale Ansicht der API Ihrer Integration ermöglicht eine effizientere Entwicklung und Fehlerbehebung.
Stellen Sie Ihre Integrations-APIs zur Verfügung und integrieren Sie sie nahtlos in konversationelle Agents. Weitere Informationen finden Sie unter Konversationelle Agents mit Application Integration erstellen.

Was ist die OpenAPI-Spezifikation?

Die OpenAPI-Spezifikation (OAS) ist ein standardisiertes, sprachunabhängiges Format zur Beschreibung von RESTful APIs. Die OpenAPI-Spezifikation, die in der Regel im YAML- oder JSON-Format geschrieben wird, enthält eine formelle Beschreibung der API-Elemente, z. B. der Basis-URL, Pfade und Verben, Header, Abfrageparameter, Inhaltstypen, Anfrage- und Antwortmodelle und mehr. Weitere Informationen zur OpenAPI-Spezifikation finden Sie unter OpenAPI-Spezifikation.

OpenAPI-Spezifikation generieren und ansehen

Sie können die OpenAPI-Spezifikation für Ihre Integrationen dynamisch generieren und im Integrationseditor in der Google Cloud Konsole oder über einen API-Aufruf ansehen.

Hinweise

Prüfen Sie, ob Ihre Integration mit einem oder mehreren API-Triggern konfiguriert ist. Informationen zum Konfigurieren von API-Triggern finden Sie unter API-Trigger.
Veröffentlichen Sie die Integration. Informationen zum Veröffentlichen einer Integration finden Sie unter Integrationen testen und veröffentlichen.

OpenAPI-Spezifikation ansehen

Wählen Sie eine der folgenden Optionen aus, um die OpenAPI-Spezifikation für Ihre Integration aufzurufen:

Konsole

So rufen Sie die OpenAPI-Spezifikation für eine bestimmte Integration auf:

Rufen Sie die Seite Application Integration auf.
Zu „Application Integration“
Klicken Sie im Navigationsmenü auf Integrationen.
Die Seite Integrationen wird angezeigt. Dort sind alle Integrationen aufgeführt, die im Google Cloud Projekt verfügbar sind.
Klicken Sie auf die Integration, für die Sie die OpenAPI-Spezifikation aufrufen möchten. Dadurch wird die Integration im Integrationseditor geöffnet.
Klicken Sie in der Symbolleiste des Integrationseditors auf das more_vert-Menü (Aktionen) und wählen Sie OpenAPI-Spezifikation ansehen aus.
Der Bereich OpenAPI-Spezifikation ansehen wird angezeigt und enthält die OpenAPI-Spezifikation der Integration. Die generierte OpenAPI-Spezifikation enthält standardmäßig alle in der Integration konfigurierten API-Trigger.
- Wenn Sie die OpenAPI-Spezifikation für einen bestimmten API-Trigger aufrufen möchten, wählen Sie den API-Trigger aus der Drop-down-Liste APIs aus.
- Wenn Sie die OpenAPI-Spezifikation als YAML-Datei herunterladen möchten, klicken Sie auf Herunterladen .

API

Mit der Methode generateOpenApiSpec der Application Integration API können Sie die OpenAPI-Spezifikation für Ihre Integration über einen API-Aufruf aufrufen.

Verwenden Sie den folgenden curl-Befehl, um die OpenAPI-Spezifikation für eine oder mehrere Integrationen in derselben Region aufzurufen:

Tipp:curl ist normalerweise auf Linux- und macOS-Betriebssystemen vorinstalliert. Wenn curl nicht installiert ist, können Sie es von der Seite „Releases und Downloads“ für curl herunterladen.

curl -X POST \
    -H "authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json" \
    -d '{
    "apiTriggerResources": [{
    "integrationResource": "INTEGRATION_NAME",
    "triggerId": ["api_trigger/TRIGGER_NAME", "api_trigger/TRIGGER_NAME_2", "api_trigger/TRIGGER_NAME_n"]
    },
    {
    "integrationResource": "INTEGRATION_NAME",
      "triggerId": ["api_trigger/TRIGGER_NAME"]
    }],
    "fileFormat": "DOC_TYPE"
    }' \
    "https://LOCATION-integrations.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION:generateOpenApiSpec"

Ersetzen Sie Folgendes:

TRIGGER_NAME, TRIGGER_NAME_2, TRIGGER_NAME_n: Die Namen der API-Trigger in Ihrer Integration, für die Sie die OpenAPI-Spezifikation aufrufen möchten.
INTEGRATION_NAME: Der Name Ihrer Integration.
DOC_TYPE: Der Typ des zu generierenden Dokuments. Die folgenden Werte werden unterstützt: YAML oder JSON.
PROJECT_ID: Die ID Ihres Google Cloud -Projekts.
LOCATION: Der Standort Ihres Google Cloud -Projekts.
Hinweis:Sie können die OpenAPI-Spezifikation für mehrere Integrationen nur in derselben Region aufrufen.