Informationen zu den unterstützten Connectors für Application Integration.

OpenAPI-Spezifikation für Ihre Integration ansehen

Vorschau — OpenAPI Specification

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 der Anwendungsintegration können Sie die OpenAPI-Spezifikationen Ihrer veröffentlichten Integrationen, die mit einem oder mehreren API-Triggern konfiguriert sind, dynamisch generieren und aufrufen. Wenn Sie auf die OpenAPI-Spezifikation Ihrer Integration zugreifen, haben Sie folgende Möglichkeiten:

• Sie erhalten ein umfassendes Verständnis der API-Endpunkte, Methoden und Datenstrukturen Ihrer Integration.
• Sie können die Entwicklung und Fehlerbehebung effizienter gestalten, indem Sie eine detaillierte und zentrale Ansicht der API Ihrer Integration bereitstellen.
• Stellen Sie Ihre Integrations-APIs bereit und integrieren Sie sie nahtlos in Konversations-Agenten wie Google Cloud-Konversations-Agenten.

Was ist die OpenAPI-Spezifikation?

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

Hinweis:Die Anwendungsintegration unterstützt nur die OpenAPI-Spezifikation Version 3.0.1.

OpenAPI-Spezifikation generieren und ansehen

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

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 aufrufen

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

Console

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

1. Rufen Sie die Seite Anwendungsintegration auf.

   Zu „Application Integration“

2. Klicken Sie im Navigationsmenü auf Integrationen.

   Die Seite Integrationen wird angezeigt. Dort sind alle Integrationen aufgeführt, die im Projekt Google Cloud verfügbar sind.

3. Klicken Sie auf die Integration, für die Sie die OpenAPI-Spezifikation aufrufen möchten. Dadurch wird die Integration im Integrationseditor geöffnet.
4. Klicken Sie in der Symbolleiste des Integrationseditors auf (Aktionsmenü) und wählen Sie OpenAPI-Spezifikation ansehen aus.

   Der Bereich OpenAPI-Spezifikation ansehen wird angezeigt. Er 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 ihn in der Drop-down-Liste APIs aus.
   • Wenn Sie die OpenAPI-Spezifikation als YAML-Datei herunterladen möchten, klicken Sie auf Herunterladen .

Hinweis:Sie können die OpenAPI-Spezifikation im YAML-Format jeweils nur für eine einzelne Integration im Integrationseditor aufrufen und herunterladen. Wenn Sie die OpenAPI-Spezifikation im YAML- oder JSON-Format aufrufen und herunterladen möchten, folgen Sie der Anleitung im Abschnitt API.

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/integrations/-: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 zu generierende Dokumenttyp. Folgende Werte werden unterstützt: YAML oder JSON.
• PROJECT_ID: Die ID Ihres Google Cloud -Projekts.
• LOCATION: Der Speicherort Ihres Google Cloud -Projekts.
  Hinweis: Sie können die OpenAPI-Spezifikation nur für mehrere Integrationen in derselben Region aufrufen.

OpenAPI-Spezifikation

Die Anwendungsintegration generiert die OpenAPI-Spezifikation für Ihre veröffentlichten Integrationen gemäß dem Standard OpenAPI Specification 3.0. In der folgenden Tabelle werden die Elemente der OpenAPI-Spezifikation beschrieben, die in Application Integration generiert werden:

Element	Beschreibung
openapi	Die verwendete OpenAPI-Spezifikationsversion.
info	Informationen zur Integration, z. B. Name (Titel), Beschreibung und veröffentlichte Version.
servers	Die Server-URLs, auf denen die Integration gehostet wird.
paths	Für jeden ausgewählten API-Trigger in der Integration werden Pfade erstellt. Die Server-URL in Kombination mit dem Pfad bildet den API-Endpunkt für API-Aufrufe. Die Felder Request und Response werden basierend auf den Eingabe- und Ausgabevariablen ausgefüllt, die für den entsprechenden API-Trigger konfiguriert sind. Hinweis:Die Anwendungsintegration unterstützt derzeit nur eine begrenzte Anzahl von JSON-Schema-Keywords. Informationen zu den unterstützten Keywords finden Sie unter Hinweise.
components	Das Feld schemas enthält das JSON-Schema für die Eingabe- und Ausgabevariablen des API-Triggers. Das Feld securitySchemes enthält die Authentifizierungsinformationen für die API-Trigger.

Hinweise

Beachten Sie beim Betrachten der OpenAPI-Spezifikation für Ihre Integration Folgendes:

• Die OpenAPI-Spezifikation wird nur für veröffentlichte Integrationen generiert.
• Die OpenAPI-Spezifikation wird nur für Integrationen generiert, die mit einem oder mehreren API-Triggern konfiguriert sind.
• Die OpenAPI-Spezifikation wird nur für Integrationen in derselben Region generiert.
• Die OpenAPI-Spezifikation wird standardmäßig im YAML-Format generiert. Wenn Sie die OpenAPI-Spezifikation im JSON-Format generieren und anzeigen möchten, legen Sie im API-Aufruf den Parameter fileFormat auf JSON fest.
• Die Anwendungsintegration unterstützt derzeit nur die folgenden JSON-Schema-Keywords:
  • type
  • items
  • properties
  • description
  • required
  • array
  • object
  • oneOf
  • allOf
  • anyOf
  • not
  • null
  • enum
  • additionalProperties
  • default
• Wenn Sie die OpenAPI-Spezifikation mit dem Swagger-Editor validieren, treten möglicherweise semantische Fehler im Zusammenhang mit den API-Pfaden auf, die dem folgenden Bild ähneln:

  

  Diese Fehler können ignoriert werden. Die OpenAPI-Spezifikation ist weiterhin gültig.