Verwenden des API-Portals für VMware Tanzu

Dieser Artikel gilt für:❌ Basic/Standard ✔️ Enterprise

In diesem Artikel erfahren Sie, wie Sie das API-Portal für VMware Tanzu mit dem Azure Spring Apps Enterprise-Plan verwenden.

Das API-Portal ist eine der kommerziellen VMware Tanzu-Komponenten. Das API-Portal unterstützt das Anzeigen von API-Definitionen über Spring Cloud Gateway für VMware Tanzu sowie das Testen bestimmter API-Routen über den Browser. Außerdem wird die Aktivierung von Authentifizierung mit einmaligem Anmelden (SSO) über die Konfiguration unterstützt.

Voraussetzungen

• Eine bereits bereitgestellte Azure Spring Apps Enterprise-Planinstanz mit aktiviertem API-Portal. Weitere Informationen finden Sie unter Schnellstart: Erstellen und Bereitstellen von Anwendungen in Azure Spring Apps mit dem Enterprise Plan.
• Das Spring Cloud-Gateway für Tanzu wird während der Bereitstellung aktiviert, und die entsprechenden API-Metadaten werden konfiguriert.

Konfigurieren des einmaligen Anmeldens (Single Sign-On, SSO)

Das API-Portal unterstützt Authentifizierung und Autorisierung mit einmaligem Anmelden (Single Sign-On, SSO) mit einem OpenID-Identitätsanbieter (IdP), der das OpenID Connect-Ermittlungsprotokoll unterstützt.

Informationen zum Einrichten von SSO mit Microsoft Entra ID finden Sie unter Einrichten des einmaligen Anmeldens mit Microsoft Entra ID für Spring Cloud Gateway und das API-Portal für Tanzu.

Konfigurieren der Anzahl der Instanzen

az spring api-portal update --instance-count <number>

Zuweisen eines öffentlichen Endpunkts für das API-Portal

az spring api-portal update --assign-endpoint

Konfigurieren des Features zum Testen von APIs

Über das API-Portal können Sie APIs zentral anzeigen und testen, indem Sie das Feature zum Ausprobieren von APIs verwenden. Die Funktion zum Testen von APIs ist standardmäßig aktiviert, und diese Konfiguration hilft Ihnen dabei, sie in der gesamten API-Portalinstanz zu deaktivieren. Weitere Informationen finden Sie im Abschnitt Testen von APIs im API-Portal.

az spring api-portal update \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-service-instance-name> \
    --enable-api-try-out

az spring api-portal update \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-service-instance-name> \
    --enable-api-try-out false

Konfigurieren von API-Routing mit der OpenAPI-Spezifikation in Spring Cloud Gateway für Tanzu

In diesem Abschnitt wird beschrieben, wie Sie APIs mit Schemadefinitionen im API-Portal anzeigen und ausprobieren. Führen Sie die folgenden Schritte aus, um API-Routing mit einer URL nach OpenAPI-Spezifikation in Spring Cloud Gateway für Tanzu zu konfigurieren.

1. Erstellen Sie eine App in Azure Spring Apps, an die das Gateway Datenverkehr weiterleitet.

2. Generieren Sie die OpenAPI-Definition, und rufen Sie den URI ab, um darauf zuzugreifen. Die folgenden beiden URI-Optionen werden akzeptiert:

   • Die erste Option besteht darin, einen öffentlich zugänglichen Endpunkt wie den URI https://petstore3.swagger.io/api/v3/openapi.json zu verwenden, der die OpenAPI-Spezifikation enthält.
   • Die zweite Option besteht darin, die OpenAPI-Definition im relativen Pfad der App in Azure Spring Apps zu platzieren und den URI im Format http://<app-name>/<relative-path-to-OpenAPI-spec> zu erstellen. Sie können Tools wie SpringDocs auswählen, um die OpenAPI-Spezifikation automatisch zu generieren, sodass der URI wie http://<app-name>/v3/api-docs aussehen kann.

3. Verwenden Sie den folgenden Befehl, um dem Gateway einen öffentlichen Endpunkt zuzuweisen, um darauf zuzugreifen.

   az spring gateway update --assign-endpoint
   

4. Verwenden Sie den folgenden Befehl, um die Spring Cloud Gateway für Tanzu-Eigenschaften zu konfigurieren:

   az spring gateway update \
       --api-description "<api-description>" \
       --api-title "<api-title>" \
       --api-version "v0.1" \
       --server-url "<endpoint-in-the-previous-step>" \
       --allowed-origins "*"
   

5. Konfigurieren sie Routingregeln für die Apps.

   Um Regeln für den Zugriff auf die App in Spring Cloud Gateway für die Tanzu-Routenkonfiguration zu erstellen, speichern Sie den folgenden Inhalt in der Datei sample.json.

   {
      "open_api": {
         "uri": "https://petstore3.swagger.io/api/v3/openapi.json"
      },
      "routes": [
         {
            "title": "Petstore",
            "description": "Route to application",
            "predicates": [
               "Path=/pet",
               "Method=PUT"
            ],
            "filters": [
               "StripPrefix=0"
            ]
         }
      ]
   }
   

   Der open_api.uri-Wert ist der öffentliche Endpunkt oder URI, der im zweiten Schritt oben erstellt wurde. Sie können Prädikate und Filter für Pfade hinzufügen, die in Ihrer OpenAPI-Spezifikation definiert sind.

   Verwenden Sie den folgenden Befehl, um die Regel auf die im ersten Schritt erstellte App anzuwenden:

   az spring gateway route-config create \
       --name sample \
       --app-name <app-name> \
       --routes-file sample.json
   

6. Überprüfen Sie die Antwort der erstellten Routen. Sie können die Routen auch im Portal anzeigen.

Anzeigen verfügbarer APIs im API-Portal

Wählen Sie die endpoint URL aus, um zum API-Portal zu navigieren. Es werden alle Routen angezeigt, die in Spring Cloud Gateway für Tanzu konfiguriert sind.

Testen von APIs im API-Portal

Gehen Sie folgendermaßen vor, um APIs zu testen:

1. Wählen Sie die API aus, die Sie testen möchten.

2. Wählen Sie EXECUTE aus. Die Antwort wird dann angezeigt.

   

Aktivieren/Deaktivieren des API-Portals nach der Diensterstellung

Sie können das API-Portal nach der Diensterstellung über das Azure-Portal oder die Azure CLI aktivieren und deaktivieren. Bevor Sie das API-Portal deaktivieren, müssen Sie die Zuweisung des Endpunkts aufheben.

az spring api-portal create \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-service-instance-name>

az spring api-portal delete \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-service-instance-name>

Nächste Schritte

• Azure Spring Apps