API Gateway:Utiliser un service backend pour créer et gérer des API

Fonctionnement des services backend

Un service backend découple l'endpoint backend réel de la définition de l'API. Au lieu de coder en dur une URL dans chaque API, associez vos API à un service backend. API Gateway achemine les requêtes entrantes vers l'URL configurée pour ce service backend dans l'environnement cible.

Cette configuration centralisée offre deux fonctionnalités principales :

• Mises à jour groupées des URL : modifiez l'URL backend d'un environnement une seule fois ; toutes les API utilisant ce service backend sont automatiquement mises à jour sans nécessiter de republication manuelle.

• Dépublication groupée : supprimez l'URL backend d'un environnement ; toutes les API utilisant ce service backend dans cet environnement sont simultanément dépubliées.

Flux de travail

1. Créez un service backend

2. Définissez différentes URL pour le service backend selon les environnements

3. Créez une API

4. Créez une application et autorisez-la à appeler l'API

5. Déboguez l'API

6. Gérez toutes les API publiées utilisant le service backend dans un environnement spécifique

Étape 1 : Créer un service backend

1. Connectez-vous à la console API Gateway. Dans le volet de navigation de gauche, cliquez sur Manage APIs > Backend Services.

2. Dans le coin supérieur droit, cliquez sur Create Backend Service. Sélectionnez un type de service backend. Cet exemple utilise HTTP/HTTPS.

   Tenez compte des points suivants lors de la sélection du type :

   • Le type ne peut pas être modifié après la création du service backend. Vous pouvez toutefois mettre à jour le nom et la description à tout moment.

   • Types pris en charge : Service HTTP/HTTPS, VPC, Function Compute, OSS, EventBridge, Découverte de services, Mixte et MOCK.

Étape 2 : Définir les URL du service backend pour chaque environnement

1. Sur la page Backend Services, localisez le service backend que vous avez créé et cliquez sur Configure Backend Service and View Associated APIs dans la colonne Actions.

   La page Backend Service Definition comporte quatre onglets : Draft, Test, Pre et Production.

   • Draft : répertorie toutes les API associées à ce service backend, quel que soit l'environnement.

   • Test / Pre / Production : définissez une URL pour le service backend dans l'environnement concerné et consultez toutes les API publiées dans cet environnement qui utilisent ce service backend.

2. Sélectionnez l'onglet correspondant à l'environnement cible et cliquez sur Create dans le coin supérieur droit. Cet exemple utilise l'environnement Test.

3. Définissez l'URL pour l'environnement sélectionné, puis cliquez sur Publish. Une fois la publication réussie, créez une API.

4. La configuration de l'URL varie selon le type de service backend :

   Remarque

   • HTTP/HTTPS : saisissez l'URL du service backend.

   • VPC : sélectionnez une règle d'autorisation accordant à API Gateway l'accès au cloud privé virtuel (VPC). Cochez éventuellement Use HTTPS pour imposer le protocole HTTPS lors de l'appel au service backend.

   • Function Compute : définissez Function Type sur Event Function ou HTTP Function. Pour une fonction événementielle, configurez les paramètres requis. Pour une fonction HTTP, spécifiez un chemin de déclenchement.

   • OSS : accordez à API Gateway l'accès à votre bucket OSS avant de définir l'URL. Pour autoriser la lecture, permettez à API Gateway d'appeler l'opération oss:GetObject. Pour autoriser l'écriture, permettez-lui d'appeler oss:PutObject et oss:DeleteObject. Pour révoquer l'accès, supprimez les stratégies d'autorisation correspondantes du bucket OSS.

Étape 3 : Créer une API

1. Dans le volet de navigation de gauche, cliquez sur Manage APIs > APIs. Cliquez sur Create API dans le coin supérieur droit.

2. À l'étape Basic Information, définissez le groupe d'API, le nom, la méthode d'authentification, le type et la description. Cet exemple sélectionne AppCode Authentication (Header & Query) pour le paramètre AppCode Authentication. Cliquez sur Next.

3. À l'étape Define API request, configurez la manière dont les clients appellent l'API. Définissez les paramètres Request Type, Protocol, Request Path, HTTP Method et Request Mode, puis ajoutez tous les paramètres requis dans la section Request Parameters. Cet exemple définit HTTP Method sur GET et Request Mode sur Pass-through. Le mode Pass-through transmet les paramètres reçus au service backend sans mappage de paramètres. Cliquez sur Next.

4. À l'étape Define backend service, configurez la façon dont API Gateway achemine les requêtes vers le backend. Définissez Configuration Mode sur Use Existing Backend Service et Backend Service Type sur HTTP/HTTPS Service. Sélectionnez le service backend testHttp dans la liste déroulante Backend Service. Pour prévisualiser les URL configurées pour chaque environnement, survolez View Environment Configurations et sélectionnez l'onglet correspondant. Après avoir sélectionné le service backend, définissez les paramètres Backend Request Path, HTTP Method et Backend Service Timeout Period.

5. À l'étape Define response, configurez les informations de réponse destinées à la documentation de l'API. Définissez les paramètres Response ContentType, Response Example et Error Response Example selon vos besoins. Cette étape est facultative ; cliquez sur Create pour l'ignorer.

6. Après avoir cliqué sur Create, publiez l'API dans un environnement. API Gateway prend en charge trois environnements : Production, Pre et Test. Les configurations d'API ne prennent effet qu'après publication.

   Important

   Avant de publier une API utilisant un service backend, assurez-vous qu'une URL est définie pour ce service backend dans l'environnement cible. Sans cela, la publication de l'API est impossible.

Étape 4 : Créer une application et l'autoriser à appeler l'API

1. Une application constitue l'identité utilisée pour appeler une API. Comme cette API utilise Alibaba Cloud App comme méthode d'authentification de sécurité, créez une application et accordez-lui l'autorisation d'appeler l'API après sa publication.

2. Dans le volet de navigation de gauche, cliquez sur Call APIs > Apps. L'authentification Alibaba Cloud App prend en charge deux modes : AppKey et AppSecret, ainsi que AppCode. Cet exemple utilise le mode AppCode. Pour plus de détails, consultez la rubrique Appeler une API en mode d'authentification simple.

3. Dans la liste des API, localisez l'API que vous avez créée et cliquez sur Authorize dans la colonne Actions. Définissez Stage sur l'environnement où l'API est publiée. Recherchez et sélectionnez l'application que vous avez créée, cliquez sur Add, puis sur Confirm. Un message de confirmation s'affiche lorsque l'application est autorisée.

Étape 5 : Déboguer l'API

Utilisez l'outil de débogage en ligne pour vérifier l'API avant de l'appeler depuis un client.

Sur la page APIs, cliquez sur le nom de l'API, puis sur Debug API dans la colonne Actions. Sur la page des détails de l'API, sélectionnez Debug API dans l'arborescence de navigation de gauche. Si l'API comporte des paramètres de requête définis, saisissez différentes valeurs pour vérifier la configuration. Définissez App Name sur l'application autorisée et assurez-vous que l'environnement de débogage correspond à celui où l'application est autorisée. Une incompatibilité peut entraîner l'échec du débogage.

Étape 6 : Gérer les API publiées via le service backend

1. Lorsque vous modifiez la définition d'un service backend pour un environnement, toutes les API publiées utilisant ce service backend dans cet environnement sont automatiquement republiées avec la nouvelle configuration.

2. Dans cet exemple, l'URL de testHttp est mise à jour dans l'environnement test. Un message de confirmation indique que la modification du service backend sera synchronisée avec toutes les API associées. Après la republication, le statut de publication mis à jour des API apparaît dans la liste. Toutes les requêtes adressées aux API utilisant ce service backend dans l'environnement test sont acheminées vers la nouvelle URL.

3. Pour retirer un service backend d'un environnement, supprimez sa configuration d'URL pour cet environnement. Toutes les API publiées utilisant le service backend dans cet environnement sont simultanément dépubliées.

   Avertissement

   Ces opérations s'appliquent à toutes les API associées et sont irréversibles. Procédez avec prudence.