Configuración de una solicitud de integración de la API mediante la consola de API Gateway - Amazon API Gateway
Configuración de una integración de LambdaConfiguración de integración de HTTPConfiguración de una integración servicios de AWSConfiguración de una integración simulada

Configuración de una solicitud de integración de la API mediante la consola de API Gateway

La configuración de un método de API define el método y describe sus comportamientos. Para configurar un método, debe especificar un recurso, incluida la raíz ("/"), en el que se expone el método, un método HTTP (GET, POST, etc.) y la forma en que se integrará con el backend de destino. La solicitud y la respuesta del método especifican el contrato con la aplicación que realiza la llamada, que estipula los parámetros que puede recibir la API y el aspecto que tendrá la respuesta.

Los siguientes procedimientos describen cómo utilizar la consola de API Gateway para crear una solicitud de integración.

Configuración de una integración de Lambda

Utilice una integración de función de Lambda para integrar la API con una función de Lambda. A nivel de API, es un tipo de integración de AWS si se crea una integración sin proxy o un tipo de integración de AWS_PROXY si se crea una integración de proxy.

Configuración de una integración de Lambda

  1. En el panel Recursos, elija Crear método.

  2. En Tipo de método, seleccione un método HTTP.

  3. En Tipo de integración, seleccione Función Lambda.

  4. Para usar una integración de proxy de Lambda, active la Integración de proxy de Lambda. Para obtener más información sobre las integraciones de proxy de Lambda, consulte Descripción de la integración de proxy de Lambda en API Gateway.

  5. En Función de Lambda, ingrese el nombre de la función de Lambda.

    Si utiliza una función de Lambda en una región diferente a la de su API, seleccione la región en el menú desplegable e ingrese el nombre de la función de Lambda. Si utiliza una función de Lambda entre cuentas, ingrese el ARN de la función.

  6. Si desea utilizar el valor predeterminado del tiempo de espera, que es de 29 segundos, mantenga activado el Tiempo de espera predeterminado. Para establecer un tiempo de espera personalizado, elija Tiempo de espera predeterminado e ingrese un valor de tiempo de espera comprendido entre 50 y 29000 milisegundos.

  7. (Opcional) Puede configurar los ajustes de solicitud de método mediante los siguientes menús desplegables. Elija los Ajustes de solicitud de método y configure la solicitud de método. Para obtener más información, consulte el paso 3 de Edición de una solicitud de método de API Gateway en la consola de API Gateway.

    También puede configurar los ajustes de solicitud de método después de crear el método.

  8. Elija Crear método.

Configuración de integración de HTTP

Utilice una integración de HTTP para integrar la API con un punto de conexión HTTP. En el nivel de API, este es el tipo de integración HTTP.

Configuración de integración de HTTP

  1. En el panel Recursos, elija Crear método.

  2. En Tipo de método, seleccione un método HTTP.

  3. Para Tipo de integración, elija HTTP.

  4. Para usar una integración de proxy HTTP, active la Integración de proxy HTTP. Para obtener más información acerca de las integraciones de proxy HTTP, consulte Configurar integraciones de proxy HTTP en API Gateway.

  5. En HTTP method (Método HTTP), elija el tipo de método HTTP que más se parezca al método del backend HTTP.

  6. En URL del punto de conexión, ingrese la dirección URL del backend HTTP que desea que utilice este método.

  7. En Tratamiento de contenido, seleccione un comportamiento de tratamiento del contenido.

  8. Si desea utilizar el valor predeterminado del tiempo de espera, que es de 29 segundos, mantenga activado el Tiempo de espera predeterminado. Para establecer un tiempo de espera personalizado, elija Tiempo de espera predeterminado e ingrese un valor de tiempo de espera comprendido entre 50 y 29000 milisegundos.

  9. (Opcional) Puede configurar los ajustes de solicitud de método mediante los siguientes menús desplegables. Elija los Ajustes de solicitud de método y configure la solicitud de método. Para obtener más información, consulte el paso 3 de Edición de una solicitud de método de API Gateway en la consola de API Gateway.

    También puede configurar los ajustes de solicitud de método después de crear el método.

  10. Elija Crear método.

Configuración de una integración servicios de AWS

Utilice una integración de servicios de AWS para integrar la API directamente con un servicio de AWS. En el nivel de API, este es el tipo de integración AWS.

Para configura una API de API Gateway, puede hacer lo siguiente:

  • Crear una nueva función de Lambda.

  • Configurar un permiso de recurso en la función de Lambda.

  • Realizar cualquier otra acción del servicio Lambda.

Debe elegir el Servicio de AWS.

Configuración de una integración de servicios de AWS

  1. En el panel Recursos, elija Crear método.

  2. En Tipo de método, seleccione un método HTTP.

  3. En Tipo de integración, seleccione Servicio de AWS.

  4. En AWS Region, elija la región de AWS que desea que utilice este método para llamar a la acción.

  5. En Servicio de AWS, elija el servicio de AWS al que desea que llame este método.

  6. En Subdominio de AWS, ingrese el subdominio que utiliza el servicio de AWS. Normalmente, puede dejarlo en blanco. Algunos servicios de AWS admiten subdominios como parte de los hosts. En la documentación del servicio encontrará la disponibilidad y los detalles, si están disponibles.

  7. En HTTP method (Método HTTP), seleccione el tipo de método HTTP correspondiente a la acción. Para el tipo de método HTTP, consulte la documentación de referencia de la API correspondiente al servicio de AWS que eligió en Servicio de AWS.

  8. En Tipo de acción, seleccione Usar nombre de acción para usar una acción de la API o Usar sustitución de ruta para usar una ruta de recursos personalizada. Para conocer las acciones disponibles y las rutas de recurso personalizadas, consulte la documentación de referencia de la API correspondiente al servicio de AWS que eligió en Servicio de AWS.

  9. Ingrese un Nombre de acción o una Sustitución de ruta.

  10. En Rol de ejecución, ingrese el ARN del rol de IAM que usará el método para llamar a la acción.

    Para crear un rol de IAM, puede adaptar las instrucciones de Paso 1: Crear el rol de ejecución del proxy de servicio de AWS. Especifique una política de acceso con el siguiente formato y con el número de acciones e instrucciones de recursos que desee:

    {
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "action-statement"
      ],
      "Resource": [
        "resource-statement"
      ]
    },
    ...
  ]
}

    Para ver la sintaxis de las acciones e instrucciones de recursos, consulte la documentación del servicio de AWS que eligió en Servicio de AWS.

    Para la relación de confianza del rol de IAM, especifique lo siguiente, que permite a API Gateway realizar una acción en nombre de su cuenta de AWS:

    {
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "",
      "Effect": "Allow",
      "Principal": {
        "Service": "apigateway.amazonaws.com"
      },
      "Action": "sts:AssumeRole"
    }
  ]
}

  11. Si desea utilizar el valor predeterminado del tiempo de espera, que es de 29 segundos, mantenga activado el Tiempo de espera predeterminado. Para establecer un tiempo de espera personalizado, elija Tiempo de espera predeterminado e ingrese un valor de tiempo de espera comprendido entre 50 y 29000 milisegundos.

  12. (Opcional) Puede configurar los ajustes de solicitud de método mediante los siguientes menús desplegables. Elija los Ajustes de solicitud de método y configure la solicitud de método. Para obtener más información, consulte el paso 3 de Edición de una solicitud de método de API Gateway en la consola de API Gateway.

    También puede configurar los ajustes de solicitud de método después de crear el método.

  13. Elija Crear método.

Configuración de una integración simulada

Use una integración simulada si desea que API Gateway actúe como backend y devuelva respuestas estáticas. En el nivel de API, este es el tipo de integración MOCK. Normalmente, puede usar la integración MOCK si la API aún no es definitiva, pero desea generar respuestas de API para permitir que los equipos dependientes realicen pruebas. En el método OPTION, API Gateway establece la integración MOCK como predeterminada para devolver encabezados que habilitan CORS para el recurso de la API que se aplicó.

Configuración de una integración simulada

  1. En el panel Recursos, elija Crear método.

  2. En Tipo de método, seleccione un método HTTP.

  3. Para Tipo de integración, elija Simulación.

  4. (Opcional) Puede configurar los ajustes de solicitud de método mediante los siguientes menús desplegables. Elija los Ajustes de solicitud de método y configure la solicitud de método. Para obtener más información, consulte el paso 3 de Edición de una solicitud de método de API Gateway en la consola de API Gateway.

    También puede configurar los ajustes de solicitud de método después de crear el método.

  5. Elija Crear método.