Usare il portale API per VMware Tanzu

Questo articolo si applica a: ❎ Basic/Standard ✅ Enterprise

Questo articolo illustra come usare il portale api per VMware Tanzu con il piano Azure Spring Apps Enterprise.

Il portale API è uno dei componenti commerciali di VMware Tanzu. Il portale API supporta la visualizzazione delle definizioni API da Spring Cloud Gateway per VMware Tanzu e il test di route API specifiche dal browser. Supporta anche l'abilitazione dell'autenticazione Single Sign-On (SSO) tramite la configurazione.

Prerequisiti

• Un'istanza del piano enterprise di Azure Spring Apps già con il portale per le API abilitata. Per altre informazioni, vedere Avvio rapido: Creare e distribuire app in Azure Spring Apps usando il piano Enterprise.
• Spring Cloud Gateway per Tanzu è abilitato durante il provisioning e i metadati DELL'API corrispondenti sono configurati.

Configurare l'accesso Single Sign-On (SSO)

Il portale API supporta l'autenticazione e l'autorizzazione usando l'accesso Single Sign-On (SSO) con un provider di identità OpenID (IdP) che supporta il protocollo OpenID Connect Discovery.

Per configurare l'accesso SSO con Microsoft Entra ID, vedere Come configurare l'accesso Single Sign-On con Microsoft Entra ID for Spring Cloud Gateway e portale API per Tanzu.

Configurare il numero di istanze

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

Assegnare un endpoint pubblico per il portale API

az spring api-portal update --assign-endpoint

Configurare la funzionalità try-out dell'API

Il portale API consente di visualizzare le API in modo centralizzato e provare a usare la funzionalità di prova dell'API. La prova dell'API è abilitata per impostazione predefinita e questa configurazione consente di disattivarla nell'intera istanza del portale API. Per altre informazioni, vedere la sezione Provare le API nel portale per le API.

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

Configurare il routing dell'API con la specifica OpenAPI in Spring Cloud Gateway per Tanzu

Questa sezione descrive come visualizzare e provare le API con definizioni di schema nel portale API. Usare la procedura seguente per configurare il routing dell'API con un URL della specifica OpenAPI in Spring Cloud Gateway per Tanzu.

1. Creare un'app in App Spring di Azure a cui il gateway instrada il traffico.

2. Generare la definizione OpenAPI e ottenere l'URI per accedervi. Vengono accettate le due opzioni URI seguenti:

   • La prima opzione consiste nell'usare un endpoint accessibile pubblicamente, ad esempio l'URI https://petstore3.swagger.io/api/v3/openapi.json, che include la specifica OpenAPI.
   • La seconda opzione consiste nell'inserire la definizione OpenAPI nel percorso relativo dell'app in Azure Spring Apps e costruire l'URI nel formato http://<app-name>/<relative-path-to-OpenAPI-spec>. È possibile scegliere strumenti come SpringDocs generare automaticamente la specifica OpenAPI, in modo che l'URI possa essere simile http://<app-name>/v3/api-docsa .

3. Usare il comando seguente per assegnare un endpoint pubblico al gateway per accedervi.

   az spring gateway update --assign-endpoint
   

4. Usare il comando seguente per configurare le proprietà spring cloud gateway per Tanzu:

   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. Configurare le regole di routing per le app.

   Per creare regole per accedere all'app nella configurazione della route Spring Cloud Gateway for Tanzu, salvare il contenuto seguente nel file 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"
            ]
         }
      ]
   }
   

   Il open_api.uri valore è l'endpoint pubblico o l'URI costruito nel secondo passaggio precedente. È possibile aggiungere predicati e filtri per i percorsi definiti nella specifica OpenAPI.

   Usare il comando seguente per applicare la regola all'app creata nel primo passaggio:

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

6. Controllare la risposta delle route create. È anche possibile visualizzare le route nel portale.

Visualizzare le API esposte nel portale api

Selezionare per endpoint URL passare al portale API. Vengono visualizzate tutte le route configurate in Spring Cloud Gateway per Tanzu.

Provare le API nel portale api

Usare la procedura seguente per provare le API:

1. Selezionare l'API da provare.

2. Selezionare EXECUTE e viene visualizzata la risposta.

   

Abilitare/disabilitare il portale API dopo la creazione del servizio

È possibile abilitare e disabilitare il portale API dopo la creazione del servizio usando il portale di Azure o l'interfaccia della riga di comando di Azure. Prima di disabilitare il portale API, è necessario annullarne l'assegnazione.

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>

Passaggi successivi

• Azure Spring Apps