Trabajar con mapeos de la API para las API REST
Los mapeos de la API se utilizan para conectar etapas de la API a un nombre de dominio personalizado. Después de crear un nombre de dominio y configurar registros DNS, se utilizan mapeos de la API para enviar tráfico a las API a través del nombre de dominio personalizado.
Un mapeo de la API especifica una API, una etapa y, de forma opcional, una ruta que se utilizará para el mapeo. Por ejemplo, puede mapear la etapa de production de una API a https://api.example.com/orders.
Puede mapear etapas de la API HTTP y REST al mismo nombre de dominio personalizado.
Antes de crear un mapeo de la API, debe tener una API, una etapa y un nombre de dominio personalizado. Para obtener más información sobre cómo crear un nombre de dominio personalizado, consulte Configuración de un nombre de dominio regional personalizado en API Gateway.
Enrutamiento de solicitudes de la API
Puede configurar mapeos de la API con varios niveles, por ejemplo orders/v1/items y orders/v2/items.
Para configurar mapeos de la API con varios niveles, el nombre de dominio personalizado debe ser regional y utilizar la política de seguridad de TLS 1.2.
API Gateway direcciona las solicitudes al mapeo de la API que tiene la ruta de coincidencia más larga. API Gateway solo considera las rutas configuradas para los mapeos de la API, y no las rutas de la API, para seleccionar la API que se va a invocar. Si ninguna ruta coincide con la solicitud, API Gateway envía la solicitud a la API que ha mapeado a la ruta vacía (none).
Por ejemplo, considere un nombre de dominio personalizado https://api.example.com con los siguientes mapeos de la API:
-
(none)mapeado a la API 1. -
orders/v1/itemsmapeado a la API 2. -
orders/v2/itemsmapeado a la API 3. -
orders/v2/items/categoriesmapeado a la API 4.
| Solicitud | API seleccionada | Explicación |
|---|---|---|
|
|
|
La solicitud coincide exactamente con este mapeo de la API. |
|
|
|
La solicitud coincide exactamente con este mapeo de la API. |
|
|
|
API Gateway elige el mapeo que tiene la ruta de coincidencia más larga. El |
|
|
|
API Gateway elige el mapeo que tiene la ruta de coincidencia más larga. |
|
|
|
API Gateway utiliza la asignación vacía como un catch-all. |
Restricciones
-
En un mapeo de la API, el nombre de dominio personalizado y las API mapeadas deben estar en la misma cuenta de AWS.
-
Los mapeos de la API deben contener solo letras, números y los siguientes caracteres:
$-_.+!*'()/. -
La longitud máxima de la ruta en un mapeo de la API es de 300 caracteres.
-
Solo puede mapear las API HTTP a un nombre de dominio regional personalizado con la política de seguridad de TLS 1.2.
-
No puede mapear las API de WebSocket al mismo nombre de dominio personalizado que una API HTTP o API REST.
Creación de un mapeo de la API
Para crear un mapeo de la API, primero debe crear un nombre de dominio personalizado, una API y una etapa. Para obtener información sobre cómo crear un nombre de dominio personalizado, consulte Configuración de un nombre de dominio regional personalizado en API Gateway.
Para ver ejemplos de las plantillas de AWS Serverless Application Model que crean todos los recursos, consulte Sessions With SAM
