Utiliser le portail des API pour VMware Tanzu

Cet article s’applique à :❌ De base/Standard ✔️ Entreprise

Cet article vous explique comment utiliser le portail d’API pour VMware Tanzu avec le plan Azure Spring Apps Entreprise.

Le portail des API est l’un des composants commerciaux de VMware Tanzu. Le portail d’API prend en charge l’affichage des définitions d’API à partir de Spring Cloud Gateway pour VMware Tanzu ainsi que les tests de routes d’API spécifiques à partir du navigateur. Il prend également en charge l’activation de l’authentification unique via la configuration.

Prérequis

• Une instance de plan Azure Spring Apps Entreprise déjà approvisionnée avec le portail d’API activé. Pour plus d’informations, consultez Démarrage rapide : Générer et déployer des applications sur Azure Spring Apps à l’aide du plan Enterprise.
• Spring Cloud Gateway pour Tanzu est activé lors du provisionnement et les métadonnées d’API correspondantes sont configurées.

Configurer l'authentification unique (SSO)

Le portail des API prend en charge l’authentification unique (SSO) pour les autorisations et les authentifications grâce à un fournisseur d’identité (IdP) OpenID qui prend en charge le protocole OpenID Connect Discovery.

Pour configurer l’authentification unique avec Microsoft Entra ID, consultez Configurer l’authentification unique avec Microsoft Entra ID pour Spring Cloud Gateway et le portail d’API pour Tanzu.

Configurer le nombre d’instances

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

Affecter un point de terminaison public pour le portail des API

az spring api-portal update --assign-endpoint

Configurer la fonctionnalité d’essai d’API

Le portail d’API vous permet d’afficher les API de manière centralisée et de les tester à l’aide de la fonctionnalité d’essai d’API. Cette fonctionnalité est activée par défaut, et cette configuration vous permet de la désactiver sur l’ensemble de l’instance du portail d’API. Pour plus d’informations, consultez la section Essayer des API dans le portail d’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

Configurer le routage d’API avec openAPI Spec sur Spring Cloud Gateway pour Tanzu

Cette section explique comment afficher et tester des API avec des définitions de schéma dans le portail d’API. Procédez comme suit pour configurer le routage d’API avec une URL de spécification OpenAPI sur Spring Cloud Gateway pour Tanzu.

1. Créez une application dans Azure Spring Apps vers laquelle la passerelle achemine le trafic.

2. Générez la définition OpenAPI et obtenez l’URI pour y accéder. Les deux options d’URI suivantes sont acceptées :

   • La première option consiste à utiliser un point de terminaison accessible publiquement comme l’URI https://petstore3.swagger.io/api/v3/openapi.json, qui inclut la spécification OpenAPI.
   • La deuxième option consiste à placer la définition OpenAPI dans le chemin relatif de l’application dans Azure Spring Apps et à construire l’URI au format http://<app-name>/<relative-path-to-OpenAPI-spec>. Vous pouvez choisir des outils comme SpringDocs pour générer automatiquement la spécification OpenAPI, afin que l’URI puisse être semblable à http://<app-name>/v3/api-docs.

3. Utilisez la commande suivante pour affecter un point de terminaison public à la passerelle pour y accéder.

   az spring gateway update --assign-endpoint
   

4. Utilisez la commande suivante pour configurer les propriétés de Spring Cloud Gateway pour 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. Configurez des règles de routage vers les applications.

   Pour créer des règles d’accès à l’application dans Spring Cloud Gateway pour la configuration de l’itinéraire Tanzu, enregistrez le contenu suivant dans le fichier 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"
            ]
         }
      ]
   }
   

   La valeur open_api.uri est le point de terminaison public ou l’URI construit à la deuxième étape ci-dessus. Vous pouvez ajouter des prédicats et des filtres pour les chemins définis dans votre spécification OpenAPI.

   Utilisez la commande suivante pour appliquer la règle à l’application créée lors de la première étape :

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

6. Vérifiez la réponse des itinéraires créés. Vous pouvez également afficher les routes dans le portail.

Afficher les API exposées dans le portail d’API

Sélectionnez la endpoint URL pour accéder au portail des API. Vous voyez toutes les routes configurées dans Spring Cloud Gateway pour Tanzu.

Essayer des API dans le portail d’API

Effectuez les étapes suivantes pour essayer les API :

1. Sélectionnez l’API que vous voulez essayer.

2. Sélectionnez EXECUTE. La réponse s’affiche.

   

Activer/désactiver le portail d’API après la création du service

Vous pouvez activer et désactiver le portail d’API après la création du service à l’aide du Portail Azure ou d’Azure CLI. Avant de désactiver le portail d’API, vous devez désattribuer son point de terminaison.

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>

Étapes suivantes

• Azure Spring Apps