Configurar integraciones simuladas en API Gateway - Amazon API Gateway

Configurar integraciones simuladas en API Gateway

Amazon API Gateway admite integraciones simuladas para métodos API. Esta característica permite a los desarrolladores de API generar respuestas de API directamente desde API Gateway sin necesidad de un backend de integración. Como desarrollador de una API, puede utilizar esta característica para que los equipos dependientes puedan trabajar con una API antes de que se complete el desarrollo del proyecto. También puede usar esta característica para aprovisionar una página de inicio para la API, en la que se proporcione una descripción general de la API y cómo navegar por ella. Para ver un ejemplo de una página de inicio como esta, consulte la solicitud y la respuesta de integración del método GET en el recurso raíz de la API de ejemplo que se describe en Tutorial: Crear una API de REST importando un ejemplo.

Como desarrollador de una API, puede decidir cómo API Gateway responde a una solicitud de integración simulada. Para ello, configura la solicitud de integración y la respuesta de integración del método para asociar una respuesta a un código de estado determinado. Para que un método con la integración simulada devuelva una respuesta 200, configure la plantilla de asignación del cuerpo de la solicitud de integración para que devuelva lo siguiente.

{"statusCode": 200}

Configure una respuesta de integración 200 para que tenga la siguiente plantilla de asignación de cuerpo; por ejemplo:

{
    "statusCode": 200,
    "message": "Go ahead without me."
}

De igual modo, para que el método devuelva, por ejemplo, una respuesta de error 500, configure la plantilla de asignación del cuerpo de la solicitud de integración para que devuelva lo siguiente.

{"statusCode": 500}

Configure una respuesta de integración 500 con, por ejemplo, la siguiente plantilla de asignación: 

{
    "statusCode": 500,
    "message": "The invoked method is not supported on the API resource."
}

Si lo desea, también puede hacer que un método de la integración simulada devuelva la respuesta de integración predeterminada sin definir la plantilla de asignación de solicitudes de integración. La respuesta de integración predeterminada es la única que tiene la opción HTTP status regex (Expresión regular de estado de HTTP) sin definir. Asegúrese de que se establecen los comportamientos de acceso directo apropiados.

nota

Las integraciones simuladas no se han diseñado para admitir plantillas de respuestas grandes. Si las necesita para su caso de uso, considere el uso de una integración de Lambda en su lugar.

Si utiliza una plantilla de asignación de solicitudes de integración, puede insertar la lógica de la aplicación para decidir qué respuesta de integración simulada debe devolverse en función de unas determinadas condiciones. Por ejemplo, puede utilizar un parámetro de consulta scope en la solicitud de entrada para determinar si se va a devolver una respuesta de éxito o error:

{
  #if( $input.params('scope') == "internal" )
    "statusCode": 200
  #else
    "statusCode": 500
  #end
}

De esta forma, el método de la integración simulada permite realizar llamadas internas mientras que otros tipos de llamadas se rechazan con respuestas de error.

En esta sección, se describe cómo utilizar la consola de API Gateway para habilitar la integración simulada para un método de la API.

Temas