Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
Déploiement REST APIs dans API Gateway
Après avoir créé votreAPI, vous devez le déployer pour le rendre appelable par vos utilisateurs.
Pour déployer unAPI, vous devez créer un API déploiement et l'associer à une étape. Une étape est une référence logique à un état de votre cycle de vie API (par exempledev,prod,beta,v2). APIles étapes sont identifiées par l'APIID et le nom de la scène. Ils sont inclus dans le URL fichier que vous utilisez pour invoquer leAPI. Chaque étape est une référence nommée à un déploiement du API et est mise à la disposition des applications clientes.
Important
Chaque fois que vous mettez à jour un stageAPI, vous devez le redéployer API vers un stage existant ou vers un nouveau stage. APILa mise à jour inclut la modification des itinéraires, des méthodes, des intégrations, des autorisateurs, des politiques de ressources et de tout autre élément autre que les paramètres de l'étape.
Au fur et à mesure de votre API évolution, vous pouvez continuer à le déployer à différentes étapes en tant que différentes versions duAPI. Vous pouvez également déployer vos API mises à jour en tant que déploiement d'une version Canary. Cela permet à vos API clients d'accéder, au même moment, à la version de production via la version de production, et à la version mise à jour via la version Canary.
Pour appeler un utilisateur déployéAPI, le client soumet une demande contre un APIURL. URLIl est déterminé par le protocole ((S) ou HTTP (WSS)) d'un API utilisateur, son nom d'hôte, son nom de stage et son chemin de ressource (pour RESTAPIs). Le nom d'hôte et le nom de scène déterminent la base API URL de.
En utilisant le nom API de domaine par défaut, la base URL de a REST API (par exemple) dans une étape donnée ({stageName}
https://{restapi-id}.execute-api.{region}.amazonaws.com/{stageName}
Pour rendre API la base par défaut URL plus conviviale, vous pouvez créer un nom de domaine personnalisé (par exemple,api.example.com) pour remplacer le nom d'hôte par défaut duAPI. Pour prendre en charge plusieurs étapes APIs sous le nom de domaine personnalisé, vous devez associer une API étape à un chemin de base.
Avec un nom de domaine personnalisé {api.example.com}{basePath}
https://{api.example.com}/{basePath}
Pour chaque étape, vous pouvez optimiser les API performances en ajustant les limites de limitation des demandes par défaut au niveau du compte et en activant la mise en cache. API Vous pouvez également activer la journalisation des API appels vers CloudTrail ou CloudWatch, et sélectionner un certificat client pour le backend afin d'authentifier les API demandes. En outre, vous pouvez remplacer les paramètres au niveau de l'étape pour des méthodes individuelles et définir des variables d'étape pour transmettre des contextes d'environnement spécifiques à l'étape à l'intégration lors de l'exécution. API
Les étapes permettent un contrôle de version robuste de votreAPI. Par exemple, vous pouvez API déployer un sur une test étape et une prod étape, utiliser la test phase comme version de test et utiliser la prod phase comme version stable. Une fois que les mises à jour passent le test, vous pouvez migrer l'étape test vers l'étape prod. La promotion peut être effectuée en redéployant le API vers la prod scène ou en mettant à jour la valeur d'une variable d'étape du nom de scène test à celui deprod.
Dans cette section, nous expliquons comment déployer un API en utilisant la console API Gateway
Rubriques
