Erste Schritte mit API Gateway und dem API-Hub

In dieser Anleitung erfahren Sie, wie Sie API Gateway mit dem API-Hub verbinden, um die API-Metadaten aus Ihrem API Gateway-Projekt nahtlos im API-Hub zu veröffentlichen.

In dieser Anleitung verwenden Sie die Google Cloud -Konsole.

Aufgabenliste

Verwenden Sie beim Durcharbeiten der Anleitung die folgende Aufgabenliste. Alle Aufgaben sind erforderlich, um API Gateway mit dem API-Hub zu verbinden.

  1. Führen Sie die unter Vorbereitung beschriebenen Schritte aus.

  2. API in API Gateway bereitstellen

  3. API Gateway-Projekt an API-Hub anhängen

  4. API Gateway-API im API-Hub ansehen

  5. MCP-Gateway im API-Hub ansehen

  6. Vermeiden Sie Gebühren, die Ihrem Google Cloud-Konto in Rechnung gestellt werden. Siehe Bereinigen.

Hinweis

Bevor Sie beginnen, müssen Sie die folgenden Voraussetzungen erfüllen:

  1. API Gateway in Ihrem Projekt einrichten

  2. API-Hub in Ihrem Hostprojekt einrichten

API Gateway in Ihrem Projekt einrichten

So richten Sie API Gateway in Ihrem Projekt ein:

  1. Rufen Sie in der Google Cloud Console die Seite API Gateway auf.

    Zu API Gateway

  2. Für API Gateway müssen Sie die folgenden Google-Dienste aktivieren:

    Name Titel
    apigateway.googleapis.com API Gateway API
    servicemanagement.googleapis.com Service Management API
    servicecontrol.googleapis.com Service Control API

    Wenn Sie diese Dienste für das ausgewählte Projekt nicht aktiviert haben, werden Sie jetzt dazu aufgefordert.

  3. Prüfen Sie, ob für Ihr Projekt die Abrechnung aktiviert ist.

    Weitere Informationen zum Aktivieren der Abrechnung

API-Hub in Ihrem Hostprojekt einrichten

  1. Erstellen Sie ein Google Cloud -Projekt oder wählen Sie eines aus, das als Hostprojekt verwendet werden soll.

    Ein Hostprojekt ist ein Google Cloud Projekt in Ihrer Google Cloud Organisation, das Sie als Nutzerprojekt für alle API-Hubressourcen festlegen. Pro Hostprojekt kann genau eine API-Hubinstanz bereitgestellt werden.

    Damit APIs in allen API-Gateways zentral ermittelt werden können, empfehlen wir, ein dediziertes Hostprojekt für die API-Hubinstanz zu verwenden und mehrere API-Gateway-Projekte, die als Laufzeitprojekte bezeichnet werden, an die API-Hubinstanz anzuhängen.

  2. IAM-Rollen (Identity and Access Management) gewähren, die zum Verbinden von API Gateway mit dem API-Hub erforderlich sind.

  3. API-Hub in Ihrem Hostprojekt bereitstellen

API in API Gateway bereitstellen

Führen Sie die API Gateway-Kurzanleitung aus, um einen „Hello World“-Cloud Run-Dienst bereitzustellen und ein Gateway zu erstellen, das auf diesen Dienst verweist.

Die helloworld-API wird beispielsweise im helloworld-gateway-API-Gateway bereitgestellt, wie auf der Seite „Gateways“ in Google Cloud console zu sehen ist.

Die API „helloworld“ wird auf dem Gateway „helloworld-gateway“ gehostet.

API Gateway-Projekt an den API-Hub anhängen

So hängen Sie Ihr API Gateway-Projekt an den API-Hub an:

  1. Rufen Sie in der Google Cloud Console die Seite API-Hub auf.

    Zum API-Hub

  2. Wählen Sie in der Drop-down-Liste Ihr API-Hub-Hostprojekt aus.
  3. Klicken Sie im linken Navigationsmenü auf  Einstellungen, um die Seite Einstellungen zu öffnen.
  4. Rufen Sie den Tab Projektverknüpfungen auf.
  5. Klicken Sie auf Laufzeitprojekt anhängen.
    Der Bereich Ressource auswählen wird angezeigt.
  6. Klicken Sie auf das Google Cloud -Projekt, in dem API Gateway bereitgestellt wird.
  7. Wählen Sie im Bereich Einstellungen für die Projektzuordnung die Option API Gateway und alle anderen API-Assets aus, die Sie automatisch importieren möchten.
  8. Klicken Sie auf Speichern.

Ihr Laufzeitprojekt wird angehängt und in der Liste der angehängten Laufzeitprojekte in der Google Cloud Console angezeigt.

Beispiel:

Das Projekt „myproject“ ist als Laufzeitprojekt im API-Hub angehängt.

API Gateway API im API-Hub ansehen

So rufen Sie Ihre API Gateway API im API-Hub auf:

  1. Rufen Sie in der Google Cloud Console im API-Hub die Seite APIs auf.

    Zum API-Hub

  2. Suchen Sie die „Hallo Welt“-API, die Sie in API Gateway bereitgestellt haben.

    Wählen Sie bei Bedarf im Drop-down-Menü Filter die Option Gateway: API Gateway aus, um nur die API Gateway-APIs aufzurufen.

    Beispiel:

    Die API „helloworld“ wird auf der Seite „APIs“ im Hub angezeigt.

  3. Klicken Sie auf die API, um weitere Details aufzurufen, einschließlich der API-Metadaten.

MCP-Gateway im API-Hub ansehen

Wenn Ihre API-Gateway-API als MCP-Server (Model Context Protocol) konfiguriert ist, fügt API Hub einen zweiten Eintrag dafür mit dem Namen <your-api> (MCP) hinzu. Weitere Informationen finden Sie unter Erkennung über den API-Hub und die Agent Registry in der MCP-Übersicht.

Nur Gateways, für die MCP aktiviert ist, zeigen diese zusätzlichen Einträge im API-Hub an.

So rufen Sie die Details zu Ihrem MCP Gateway im API-Hub auf:

  1. Rufen Sie in der Google Cloud Console im API-Hub die Seite APIs auf.
  2. Suchen Sie den Eintrag mit dem Namen <your-api> (MCP).
  3. Klicken Sie auf die API, um die zugehörigen Details aufzurufen, einschließlich MCP-spezifischer Metadaten und Tools.

So wird beispielsweise die API helloworld (MCP) neben der Standard-API helloworld im API-Hub angezeigt:

APIs „helloworld“ und „helloworld (MCP)“ im API-Hub

Sie können diesen MCP-Server auch in der Agent Registry aufrufen. Agenten können den Server und seine Tools automatisch über den Katalog erkennen.

Der MCP-Server wird beispielsweise in Agent Registry auf dem Tab MCP Servers (MCP-Server) angezeigt:

MCP-Server in der Agent Registry

Bereinigen

So vermeiden Sie, dass Ihrem Google Cloud Konto die in dieser Anleitung verwendeten Ressourcen in Rechnung gestellt werden:

Alternativ können Sie auch die Google Cloud für diese Anleitung verwendeten Projekte löschen.

Nächste Schritte