Desarrollo de las API de REST en API Gateway - Amazon API Gateway

Desarrollo de las API de REST en API Gateway

En Amazon API Gateway, las API REST se crean como una colección de entidades programables conocidas como recursos de API Gateway. Por ejemplo, se utiliza un recurso RestApi para representar una API que puede contener una colección de entidades Resource.

Cada entidad Resource puede tener uno o más recursos Method. Un Method es una solicitud entrante enviada por el cliente y que se expresa en los parámetros de solicitud y en el cuerpo. Define la interfaz de programación de aplicaciones del cliente para acceder al Resource expuesto. Para integrar el Method con un punto de conexión de backend, también conocido como punto de conexión de integración, se crea un recurso de integración. Esto reenvía la solicitud entrante a un URI de punto de conexión de integración específico. Si es necesario, puede transformar los parámetros de solicitud o el cuerpo para que cumplan los requisitos del backend.

Para las respuestas, puede crear un recurso MethodResponse para representar una respuesta de solicitud recibida por el cliente y crear un recurso IntegrationResponse para representar la respuesta de solicitud que devuelve el backend. Puede configurar la respuesta de integración para transformar los datos de respuesta del backend antes de devolver los datos al cliente o transferir la respuesta del backend tal y como está al cliente.

Para ayudar a sus clientes a comprender su API, también puede proporcionar documentación para la API, como parte de la creación de la API o una vez que se ha creado. Para ello, agregue un recurso DocumentationPart para una entidad de API compatible.

Para controlar el modo en que los clientes llaman a la API, utilice permisos de IAM, un autorizador de Lambda o un grupo de usuarios de Amazon Cognito. Para medir el uso de la API, configure planes de uso para limitar las solicitudes a la API. Puede habilitar estos elementos al crear o al actualizar la API.

Para obtener una introducción sobre cómo crear una API, consulte Tutorial: Creación de una API de REST con una integración de proxy de Lambda. Para obtener más información sobre las funciones de API Gateway que puede utilizar al desarrollar una API de REST, consulte los siguientes temas. Estos temas contienen información conceptual y procedimientos que puede realizar a través de la consola de API Gateway, la API de REST de API Gateway, la AWS CLI o uno de los AWS SDK.

Temas