Pour isoler le trafic de développement, de préproduction et de production, API Gateway propose trois environnements intégrés (TEST, PRE et RELEASE) et vous permet de créer des environnements personnalisés qui associent les mêmes configurations d'API à différentes URL backend.
Fonctionnement des environnements
API Gateway achemine chaque requête d'API vers une URL backend en fonction de l'environnement cible. Une même configuration d'API peut pointer vers une URL backend différente dans chaque environnement, ce qui vous permet de valider les modifications en toute sécurité avant leur déploiement en production.
Pour utiliser les environnements, suivez ces étapes :
(Facultatif) Créez un environnement personnalisé : utilisez la console API Gateway pour créer des environnements supplémentaires au-delà des trois environnements intégrés.
Configurez votre service backend : définissez une URL backend différente pour chaque environnement afin que les requêtes d'API soient acheminées vers le backend approprié.
Configurez votre client : les clients doivent cibler un environnement spécifique. Associez un nom de domaine distinct à chaque environnement ou exigez que les clients envoient l'en-tête X-Ca-Stage dans leurs requêtes.
Créer un environnement
API Gateway fournit trois environnements intégrés : TEST, PRE et RELEASE. Si ces environnements ne répondent pas à vos besoins, créez un environnement personnalisé.
Connectez-vous à la console API Gateway pour afficher les environnements disponibles.
-
Cliquez sur Create Environment. Dans la boîte de dialogue Create Environment, renseignez les champs suivants. Le nom et l'alias de l'environnement doivent être uniques à l'échelle globale.
Environment Name : 2 à 10 caractères ; uniquement des lettres majuscules et des chiffres ; doit commencer par une lettre majuscule.
Alias : nom d'affichage de l'environnement. 2 à 50 caractères ; lettres, chiffres et traits de soulignement (_) autorisés.
Description : brève description de l'environnement.
Cliquez sur Confirm pour créer l'environnement.
Utiliser les environnements
Configurer un service backend avec des URL par environnement
Gérez vos applications backend d'API à l'aide de services backend, puis configurez une URL différente pour chaque environnement. Pour obtenir des instructions de configuration, consultez les étapes 1 et 2 de la rubrique Utiliser un service backend pour créer et gérer des API.
Publier des API dans un environnement
Après avoir créé et configuré un service backend, créez une API afin que les clients puissent l'appeler. Pour savoir comment créer et déboguer une API, reportez-vous aux étapes 3, 4 et 5 de la rubrique Utiliser un service backend pour créer et gérer des API. Vous pouvez publier l'API dans n'importe quel environnement, y compris TEST, PRE, RELEASE et tous les environnements personnalisés que vous avez créés.
Utiliser l'en-tête X-Ca-Stage pour cibler un environnement
Lors du débogage, vous pouvez tester votre API à l'aide du nom de domaine de deuxième niveau fourni par le système ou de l'en-tête de requête X-Ca-Stage. Si vous avez associé un nom de domaine indépendant au groupe d'API et défini le paramètre Environment sur Default (X-Ca-Stage), les clients peuvent utiliser l'en-tête X-Ca-Stage pour cibler un environnement spécifique.
Pour appeler l'API dans l'environnement RELEASE, omettez l'en-tête X-Ca-Stage.
Pour appeler l'API dans l'environnement PRE, ajoutez l'en-tête X-Ca-Stage: PRE à chaque requête.
Pour appeler l'API dans l'environnement TEST, ajoutez l'en-tête X-Ca-Stage: TEST à chaque requête.
Pour appeler l'API dans un environnement personnalisé, ajoutez l'en-tête X-Ca-Stage: environment name en remplaçant environment name par le nom réel de l'environnement.
Associer un nom de domaine à un environnement
Associez un nom de domaine dédié à chaque environnement afin que les clients puissent appeler les API sans spécifier l'en-tête X-Ca-Stage. Sélectionnez l'environnement cible lors de l'association d'un nom de domaine indépendant à un groupe d'API. Pour plus d'instructions, consultez la rubrique Associer un nom de domaine personnalisé pour autoriser les appels d'API.
L'association de nom de domaine est prioritaire sur l'en-tête X-Ca-Stage. API Gateway achemine les requêtes en fonction de la configuration d'association, quelle que soit la valeur de l'en-tête X-Ca-Stage envoyée par le client.
Supprimer un environnement
Connectez-vous à la console API Gateway pour afficher les environnements disponibles.
Recherchez l'environnement à supprimer et cliquez sur Delete dans la colonne Actions.
Les environnements intégrés ne peuvent pas être supprimés.
Les environnements associés à des services backend ne peuvent pas être supprimés.
Les environnements contenant des API publiées ne peuvent pas être supprimés.