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.
Les mappages d’API vous permettent de connecter des étapes d’API à un nom de domaine personnalisé. Après avoir créé un nom de domaine et configuré les enregistrements DNS, vous utilisez les mappages d'API pour envoyer du trafic vers vous APIs via votre nom de domaine personnalisé.
Un mappage d’API spécifie une API, une étape et éventuellement un chemin à utiliser pour le mappage. Par exemple, vous pouvez mapper l’étape production
d’une API à https://api.example.com/orders
.
Vous pouvez mapper les étapes d’API HTTP et REST au même nom de domaine personnalisé.
Avant de créer un mappage d’API, vous devez disposer d’une API, d’une étape et d’un nom de domaine personnalisé. Pour plus d’informations sur la création d’un nom de domaine personnalisé, consultez Configuration d’un nom de domaine personnalisé régional dans API Gateway.
Routage des demandes d’API
Vous pouvez configurer des mappages d’API à plusieurs niveaux, par exemple orders/v1/items
et orders/v2/items
.
Pour les mappages d’API à plusieurs niveaux, API Gateway achemine les demandes vers le mappage d’API dont le chemin d’accès est le plus long. API Gateway prend uniquement en compte les chemins configurés pour les mappages d’API, et non les routes d’API, pour sélectionner l’API à appeler. Si aucun chemin ne correspond à la demande, API Gateway envoie celle-ci à l’API que vous avez mappée au chemin vide (none)
.
Pour les noms de domaine personnalisés qui utilisent les mappages d’API à plusieurs niveaux, API Gateway achemine les demandes vers le mappage d’API doté du préfixe correspondant le plus long.
Par exemple, imaginons un nom de domaine personnalisé https://api.example.com
doté des mappages d’API suivants :
-
(none)
mappé à l’API 1. -
orders
mappé à l’API 2. -
orders/v1/items
mappé à l’API 3. -
orders/v2/items
mappé à l’API 4. -
orders/v2/items/categories
mappé à l’API 5.
Requête | API sélectionnée | Explication |
---|---|---|
|
|
La demande correspond exactement à ce mappage d’API. |
|
|
La demande correspond exactement à ce mappage d’API. |
|
|
La demande correspond exactement à ce mappage d’API. |
|
|
API Gateway choisit le mappage d’API dont le chemin d’accès est le plus long. La présence de |
|
|
API Gateway choisit le mappage d’API dont le chemin d’accès est le plus long. |
|
|
API Gateway utilise le mappage vide comme fourre-tout. |
|
|
API Gateway choisit le mappage d’API doté du préfixe correspondant le plus long. Pour un nom de domaine personnalisé configuré avec des mappages à un seul niveau, tels que |
Restrictions
-
Dans un mappage d'API, le nom de domaine personnalisé et le nom de domaine mappé APIs doivent se trouver dans le même AWS compte.
-
Les mappages d’API ne doivent contenir que des lettres, des chiffres et les caractères suivants :
$-_.+!*'()/
. -
La longueur maximale du chemin d’un mappage d’API est de 300 caractères.
-
Vous pouvez disposer de 200 mappages d’API à plusieurs niveaux pour chaque nom de domaine.
-
Vous ne pouvez APIs mapper HTTP à un nom de domaine personnalisé régional qu'avec la politique de sécurité TLS 1.2.
-
Vous ne pouvez pas WebSocket APIs mapper vers le même nom de domaine personnalisé qu'une API HTTP ou une API REST.
-
Si vous créez un mappage d’API à plusieurs niveaux, API Gateway convertit tous les noms d’en-tête en minuscules.
Création d’un mappage d’API
Pour créer un mappage d’API, vous devez d’abord créer un nom de domaine personnalisé, une API et une étape. Pour plus d’informations sur la création d’un nom de domaine personnalisé, consultez Configuration d’un nom de domaine personnalisé régional dans API Gateway.
Pour des exemples AWS Serverless Application Model de modèles qui créent toutes les ressources, voir Sessions avec SAM
Pour créer un mappage d’API
Connectez-vous à la console API Gateway à l'adresse https://console.aws.amazon.com/apigateway.
-
Choisissez Noms de domaine personnalisés.
-
Sélectionnez un nom de domaine personnalisé que vous avez déjà créé.
-
Choisissez Mappages d’API.
-
Choisissez Configurer les mappages d’API.
-
Choisissez Ajouter un nouveau mappage.
-
Entrez une API, une Étape et, éventuellement, un Chemin d’accès.
-
Choisissez Enregistrer.