Objeto x-amazon-apigateway-integration.requestParameters - Amazon API Gateway
x-amazon-apigateway-integration.requestParametersEjemplo de

Objeto x-amazon-apigateway-integration.requestParameters

Para API REST, especifica las asignaciones de los parámetros de solicitud de método designados a los parámetros de solicitud de integración. Los parámetros de solicitud de método deben estar definidos para poder hacer referencia a ellos.

Para API HTTP, especifica los parámetros que se pasan a integraciones de AWS_PROXY con un integrationSubtype especificado.

Nombre de la propiedad Tipo Descripción
integration.request.<param-type>.<param-name> string

Para API REST, el valor es típicamente un parámetro de solicitud de método predefinido con el formato method.request.<param-type>.<param-name>, donde <param-type> puede ser querystring, path, header o body. Sin embargo, $context.VARIABLE_NAME, $stageVariables.VARIABLE_NAME, y STATIC_VALUE son también válidas. Para el parámetro body, <param-name> es una expresión de ruta JSON sin el prefijo $.

parameter string

Para las API HTTP, los parámetros de solicitud son un mapeo de clave-valor que especifica los parámetros que se pasan a integraciones de AWS_PROXY con integrationSubtype especificado. Puede proporcionar valores estáticos o datos de solicitud de mapeo, variables de etapa o variables de contexto que se evalúan en tiempo de ejecución. Para obtener más información, consulte Creación de integraciones de servicio de AWS para las API de HTTP en API Gateway.

x-amazon-apigateway-integration.requestParametersEjemplo de

El siguiente ejemplo de asignaciones de parámetros de solicitud traduce la consulta (version), el encabezado, (x-user-id) y los parámetros de ruta (service) de la solicitud de método en la consulta (stage), encabezado (x-userid) y los parámetros de ruta (op) de la solicitud de integración, respectivamente.

nota

Si está creando recursos a través de OpenAPI o AWS CloudFormation, los valores estáticos deben escribirse entre comillas simples.

Para añadir este valor desde la consola, escriba application/json en el cuadro, sin las comillas.


"requestParameters" : {
    "integration.request.querystring.stage" : "method.request.querystring.version",
    "integration.request.header.x-userid" : "method.request.header.x-user-id",
    "integration.request.path.op" : "method.request.path.service"
},