Preguntas frecuentes sobre Amazon API Gateway

Amazon API Gateway es un servicio completamente administrado que facilita a los desarrolladores la publicación, el mantenimiento, el monitoreo y la protección de las API a cualquier escala. Mediante unos pocos clics en la consola de administración de AWS, puede crear una API que haga las veces de "puerta delantera" para que las aplicaciones obtengan acceso a datos, lógica de negocio o funcionalidades desde sus servicios de back-end, como aplicaciones ejecutadas en Amazon Elastic Compute Cloud (Amazon EC2), Amazon Elastic Container Service (Amazon ECS) o AWS Elastic Beanstalk, código ejecutado en AWS Lambda o cualquier aplicación web. Amazon API Gateway administra todas las tareas relacionadas con la aceptación y el procesamiento de hasta cientos de miles de llamadas simultáneas al API, entre ellas, la administración del tráfico, el control del acceso y la autorización, la monitorización y la administración de las versiones del API. Amazon API Gateway no requiere pagos mínimos ni costos iniciales. Para las API de HTTP y las API de REST, solo se paga por las llamadas a las API que reciba y la cantidad de datos salientes transferidos. Para las API de WebSocket, solo se paga por los mensajes enviados y recibidos y por el tiempo que un usuario/dispositivo está conectado a la API de WebSocket.

Amazon API Gateway proporciona a los desarrolladores un servicio sencillo, flexible, completamente administrado y de pago por uso que administra todos los aspectos de la creación y el funcionamiento de las API sólidas para backend de aplicaciones. Con API Gateway puede lanzar servicios nuevos con mayor rapidez y una inversión menor, lo que le permite concentrarse en crear sus servicios empresariales principales. API Gateway se ha diseñado para ayudarlo con varios aspectos de la creación y administración de las API:

1) Medición. API Gateway le ayuda a definir planes que miden y restringen el acceso de desarrolladores externos a sus API. Puede definir un conjunto de planes, configurar la limitación y los límites de cuota por clave de API. API Gateway mide el tráfico a sus API de forma individual y le permite extraer los datos de uso para cada clave de API.

2) Seguridad. API Gateway proporciona varias herramientas para autorizar el acceso a sus API y controlar el acceso a las operaciones de servicio. API Gateway permite utilizar las herramientas de administración y seguridad de AWS, tales como AWS Identity and Access Management (IAM) y Amazon Cognito, para autorizar el acceso a sus API. API Gateway puede verificar en su nombre las llamadas a las API firmadas con la misma metodología que AWS utiliza para sus propias API. Mediante el uso de autorizadores personalizados escritos como funciones de AWS Lambda, API Gateway puede ayudarle también a verificar tokens de portador de entrada, con lo que evita tener que preocuparse de la autorización en su código de back-end.

3) Resiliencia. API Gateway ayuda a administrar el tráfico mediante la limitación controlada, de manera que las operaciones de backend puedan atender los picos de tráfico. API Gateway también contribuye a mejorar el rendimiento de sus API y la latencia que los usuarios finales experimentan al almacenar en la caché el resultado de las llamadas a las API para evitar tener que llamar siempre al backend.

4) Supervisión de operaciones. Una vez que se ha publicado una API y está en uso, API Gateway le proporciona un panel de control de métricas para que monitoree las llamadas a sus servicios. El panel de control de API Gateway, mediante la integración con Amazon CloudWatch, le proporciona métricas de rendimiento de backend que abarcan las llamadas a las API, datos de latencia y tasas de errores. Puede activar métricas detalladas para cada método de las API y recibir logs de errores, acceso o depuración en CloudWatch Logs.

5) Administración del ciclo de vida. Una vez publicada una API, suele ser necesario crear y probar versiones nuevas que la mejoren o añadir funciones nuevas. API Gateway le permite operar varias versiones del API y fases de la versión simultáneamente, de modo que las aplicaciones existentes pueden seguir llamando a versiones anteriores después de que se publiquen versiones más recientes.

6) Diseño para desarrolladores. API Gateway permite crear API con rapidez y asignar contenido estático a sus respuestas para reducir las actividades de desarrollo entre equipos y el tiempo de comercialización de su aplicación. Los equipos que dependen de las API pueden comenzar con las tareas de desarrollo, mientras usted crea los procesos de back-end.

7) Comunicación bidireccional en tiempo real. Cree aplicaciones de comunicación bidireccional en tiempo real tales como aplicaciones de chat, paneles de streaming y notificaciones sin tener que ejecutar o administrar servidores. API Gateway mantiene una conexión persistente entre los usuarios conectados y permite la transferencia de mensajes entre ellos.

Amazon API Gateway ofrece dos opciones para crear las API RESTful, las API HTTP y las API REST, así como una opción para crear las API WebSocket.

API de HTTP: las API de HTTP se optimizan para crear las API que sirven de proxy para las funciones de AWS Lambda o los backends de HTTP, lo que las hace ideales para las cargas de trabajo sin servidor. Actualmente no ofrecen la funcionalidad de administración de API.

API de REST: las API de REST ofrecen las características de administración de API y la funcionalidad de proxy de API en una única solución. Las API de REST ofrecen características de administración de API como planes de uso, claves de API, publicación y monetización de las API.

API de WebSocket: las API de WebSocket mantienen una conexión persistente entre los clientes conectados para permitir la comunicación de mensajes en tiempo real. Con las API de WebSocket en API Gateway, puede definir integraciones de backend con funciones de AWS Lambda, Amazon Kinesis o cualquier punto de enlace HTTP que se invocará cuando se reciban mensajes de los clientes conectados.

Para comenzar a utilizar las API de HTTP, puede usar la consola de Amazon API Gateway, la AWS CLI, los AWS SDK o AWS CloudFormation. Para obtener más información acerca de cómo comenzar a utilizar las API de HTTP, visite nuestra documentación.

Para comenzar a utilizar las API de REST, puede usar la consola de Amazon API Gateway, la AWS CLI o los AWS SDK. Para obtener más información acerca de cómo comenzar a utilizar las API de REST, visite nuestra documentación.

Puede crear las API de RESTful usando tanto las API de HTTP como las API de REST en Amazon API Gateway.

Las API de HTTP se optimizan para crear las API que sirven de proxy para las funciones de AWS Lambda o los backends de HTTP, haciéndolos ideales para las cargas de trabajo sin servidor. Las API de HTTP son una alternativa más barata y más rápida para las API de REST, pero actualmente no admiten la funcionalidad de administración de API. Las API de REST están destinadas a las API que requieren las características de administración de API y la funcionalidad de proxy de API en una única solución.

Las API de HTTP son ideales para:

1. Crear las API de proxy para AWS Lambda o cualquier punto de enlace de HTTP
2. Crear las API modernas que están provistas de autorización de OAuth 2 y OIDC 
3. Cargas de trabajo que probablemente crezcan mucho
4. API para cargas de trabajo sensibles a latencia

1. Los clientes que pretenden pagar un único nivel de precios para un conjunto de características todo incluido necesario para crear, administrar y publicar sus API. 

Las API de HTTP vienen de forma estándar con soporte de CORS, OIDC y OAuth2 para la autenticación y la autorización, e implementaciones automáticas por etapas.

Sí, puede importar una definición de API usando OpenAPI 3. Tendrá como resultado la creación de rutas, integraciones y modelos de API. Para obtener más información sobre la importación de las definiciones de OpenAPI, consulte nuestra documentación.

Para migrar desde su API de REST actual a una API de HTTP en Amazon API Gateway, haga lo siguiente:

1. Compruebe que todas las características que usted necesita estén disponibles en HTTP. Para ver la lista de características completa, visite nuestra documentación. 
2. Vaya a su API de REST y exporte la definición de OpenAPI desde su API de REST
3. Vaya a su API de HTTP e importe la definición de OpenAPI desde el paso anterior
4. Pruebe las funciones de API como sería de esperar
5. Actualice a sus clientes con la nueva URL

Si bien su API podría funcionar, puede notar algunas características faltantes. Para identificar cualquier característica faltante, revise los campos Información, Advertencia y Error de la operación de importación. Para obtener más información acerca de la migración de las API de REST a las API de HTTP, consulte nuestra documentación.

Primero, vaya a su REST y exporte la definición de OpenAPI desde su API de REST. Luego, vaya a su API de HTTP e importe la definición de OpenAPI desde el paso anterior. Si bien su API podría funcionar, puede notar algunas características faltantes. Para identificar cualquier característica faltante, revise los campos Información, Advertencia y Error de la operación de importación. La AWS CLI devolverá información acerca de su API dentro de sus campos de información y advertencia. Para obtener más información, lea nuestra documentación.

Para empezar puede crear una API WebSocket mediante la consola de administración de AWS, la interfaz de línea de comandos (CLI) de AWS o los SDK de AWS. Después puede establecer el direccionamiento de WebSocket a fin de indicar los servicios de backend, tales como AWS Lambda, Amazon Kinesis o su punto de conexión HTTP, para que se invoquen en función del contenido de los mensajes. Consulte la documentación para comenzar a utilizar las API WebSocket en API Gateway.

Si, todas las API creadas con Amazon API Gateway solo exponen los puntos de enlace HTTPS. Amazon API Gateway no soporta puntos de enlace no cifrados (HTTP). De forma predeterminada, Amazon API Gateway asigna un dominio interno al API que utiliza automáticamente el certificado de Amazon API Gateway. Al configurar las API para que se ejecuten en un nombre de dominio personalizado, puede proporcionar su propio certificado para el dominio.

Las API creadas en Amazon API Gateway pueden aceptar cargas enviadas a través de HTTPS para las API de HTTP, las API de REST y las API de WebSocket. Los formatos de datos habituales incluyen JSON, XML, parámetros de cadenas de consultas y encabezados de solicitudes. Puede declarar cualquier tipo de contenido para las respuestas de sus API, y luego usar las plantillas de transformación para cambiar la respuesta del back-end al formato deseado.

Amazon API Gateway puede ejecutar funciones AWS Lambda en su cuenta, iniciar máquinas de estado de AWS Step Functions o llamar puntos de conexión HTTP hospedados en AWS Elastic Beanstalk, Amazon EC2, y también operaciones basadas en HTTP, no hospedadas en AWS, que son accesibles a través de la Internet pública. API Gateway también le permite especificar una plantilla de mapeo para generar contenido estático a devolver, lo que le ayuda a simular las API antes de que el backend esté listo. Además, puede integrar API Gateway directamente con otros servicios de AWS; por ejemplo, podría exponer un método API en API Gateway que envíe datos directamente a Amazon Kinesis.

API Gateway genera SDK personalizados para el desarrollo de aplicaciones móviles con Android e iOS (Swift y Objective-C), así como el desarrollo de aplicaciones web con JavaScript. API Gateway también admite la generación de SDK para Ruby y Java. Una vez que se definen una API y sus modelos en API Gateway, puede usar la consola de AWS o las API de API Gateway para generar y descargar un SDK de cliente. Los SDK de cliente solo se generan para las API REST en Amazon API Gateway.

Para ver dónde están disponibles las API de HTTP, las API de REST y las API de WebSocket, consulte la tabla de regiones de AWS aquí.

A través de la consola de Amazon API Gateway, puede definir el API REST y sus recursos y métodos asociados, administrar el ciclo de vida del API, generar SDK de cliente y visualizar las métricas del API. También puede usar la consola de API Gateway para definir sus planes de uso de las API, administrar las claves de API de los desarrolladores y configurar la limitación y los límites de cuota. También puede realizar todo esto a través de las API de API Gateway.

Un recurso es un objeto escrito que forma parte del dominio del API. Cada recurso puede estar asociado con un modelo de datos, relaciones con otros recursos y responder a diferentes métodos. También puede definir recursos como variables para interceptar solicitudes para varios recursos secundarios.

Cada recurso de un API REST soporta uno o más métodos HTTP estándar. Puede definir los verbos que soporta cada recurso (GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS) y su implementación. Por ejemplo, el verbo GET asignado al recurso “cars” (“coches”) le proporcionará una lista de coches. Para poder conectar todos los métodos de un recurso a un solo punto de enlace de backend, API Gateway también es compatible con un método especial “ANY”.

Los planes de uso lo ayudan a crear planes para desarrolladores externos que restringen el acceso solamente a determinadas API, definen la limitación controlada y los límites de cuota de solicitudes, y los asocian a claves de API. También puede extraer datos de uso de cada clave de API para analizar el uso de las API y generar documentos de facturación. Por ejemplo, puede crear planes Basic, Professional y Enterprise – puede configurar el plan de uso Basic para que solo se permitan 1 000 solicitudes al día y un máximo de 5 solicitudes por segundo (RPS).

Con Amazon API Gateway, cada API REST puede tener varias fases. Las fases sirven para ayudar con el ciclo de vida de desarrollo de un API, por ejemplo, una vez creadas e implementadas las API en fase de desarrollo o cuando están listas para producción, es posible implementarlas en la fase de producción.

En Amazon API Gateway, las fases son similares a las etiquetas. Definen la ruta a través de la cual se puede obtener acceso a una implementación. Por ejemplo, puede definir una fase de desarrollo e implementar el API “cars” en ella. El recurso se estará accesible en https://www.myapi.com/dev/cars. También puede configurar nombres de dominio personalizados que apunten directamente a una fase, de modo que no tenga que utilizar el parámetro adicional de la ruta. Por ejemplo, si apunta myapi.com directamente a la fase de desarrollo, podrá obtener acceso al recurso “cars” en https://www.myapi.com/cars. Las fases se pueden configurar con variables a las que se puede obtener acceso desde la configuración de API o desde plantillas de mapeo.

Con las variables de fase podemos definir pares clave-valor de valores de configuración asociados con una fase. Estos valores, al igual que las variables de entorno, se pueden usar en la configuración de API. Por ejemplo, podría definir el punto de enlace HTTP para la integración del método como una variable de fase y usar la variable en la configuración de API en lugar de codificar de forma rígida el punto de enlace, esto permite usar un punto de enlace distinto en cada fase (por ej., dev, beta, prod) con la misma configuración de API. Las variables de fase también son accesibles desde las plantillas de mapeo y se pueden utilizar para transmitir parámetros de configuración al back-end Lambda o HTTP.

Una política de recursos es un documento con políticas de JSON que adjunta a una API para controlar si un agente principal especificado (normalmente una función o un usuario de IAM) puede invocar la API. Puede usar una política de recursos para activar usuarios desde una cuenta de AWS diferente para obtener acceso de manera segura a su API o para permitir que la API se invoque únicamente desde bloques de CIDR o intervalos de direcciones IP específicos. Las políticas de recursos se pueden emplear con las API REST en Amazon API Gateway.

Amazon API Gateway guarda el historial de implementaciones. En cualquier momento, mediante las API o la consola de Amazon API Gateway, puede volver a una fase anterior de la implementación.

Sí. Puede usar la herramienta de importación Swagger de código abierto para importar las definiciones Swagger de la API en Amazon API Gateway. Con la herramienta de importación de Swagger, puede crear e implementar API nuevas y actualizar las existentes.

Puede capitalizar sus API en API Gateway a través de su publicación como productos en AWS Marketplace. Primero deberá registrarse como vendedor en AWS Marketplace y enviar sus planes de uso acerca de API Gateway como productos. Haga clic aquí para obtener más información acerca de la monetización de la API.

API Gateway ofrece la capacidad para crear, actualizar y eliminar documentación asociada con cada parte de su API, como métodos y recursos. Puede acceder a API relacionadas con documentación mediante AWS SDK, CLI, llamadas a RESTful o la edición de cadenas de documentación directamente en la consola de API Gateway. La documentación también se puede importar como un archivo Swagger, ya sea como parte de la API o de manera independiente, lo que le permite añadir o actualizar la documentación sin afectar la definición de la API. API Gateway forma parte de la especificación de API abierta para la documentación que se importa con origen o destino en archivos de Swagger. Se soporta la documentación para las API REST en API Gateway.

Además de ofrecer compatibilidad con documentación de API conforme a estándares, API Gateway también admite el legado de documentación, lo que simplifica la definición única de una cadena de documentación y, a continuación, el uso en varios lugares. El legado simplifica el proceso de definición de documentación de API y puede convertirse a la representación estándar cuando se exporta la API a un archivo Swagger.

Sí, puede implementar una política de recursos a una API a fin de restringir el acceso a una Amazon VPC o a un punto de enlace de VPC específico. También puede conceder a una Amazon VPC o a un punto de enlace de VPC de una cuenta diferente acceso a la API privada mediante el uso de una política de recursos.