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

Objeto x-amazon-apigateway-integration.requestParameters

Para APIs REST, especifica mapeamentos de parâmetros de solicitação de método nomeados para parâmetros de solicitação de integração. Os parâmetros de solicitação do método devem ser definidos antes de serem referenciados.

Para APIs HTTP, especifica parâmetros que são transmitidos para integrações AWS_PROXY com um integrationSubtype especificado.

Nome da propriedade Tipo Descrição
integration.request.<param-type>.<param-name> string

Para APIs REST, normalmente, o valor é um parâmetro de solicitação de método predefinido do formato method.request.<param-type>.<param-name> em que <param-type> pode ser querystring, path, header ou body. No entanto $context.VARIABLE_NAME, $stageVariables.VARIABLE_NAME e STATIC_VALUE também são válidos. Para o parâmetro body, <param-name> é uma expressão de caminho JSON sem o prefixo $.

parameter string

Para APIs HTTP, parâmetros de solicitação são um mapa de chave-valor que especifica parâmetros que são passados para integrações AWS_PROXY com um integrationSubtype especificado. Você pode fornecer valores estáticos ou mapear dados de solicitação, variáveis de estágio ou variáveis de contexto que são avaliadas no tempo de execução. Para saber mais, consulte Criar integrações de serviços da AWS para APIs HTTP no API Gateway.

Exemplo de x-amazon-apigateway-integration.requestParameters

O seguinte exemplo de mapeamentos de parâmetros de solicitação converte os parâmetros de consulta (version), cabeçalho (x-user-id) e caminho (service) de uma solicitação de método nos parâmetros de consulta (stage), cabeçalho (x-userid) e caminho (op) de uma solicitação de integração, respectivamente.

nota

Se você estiver criando recursos por meio do OpenAPI ou do AWS CloudFormation, os valores estáticos deverão estar entre aspas simples.

Para adicionar esse valor no console, digite application/json na caixa, sem aspas.


"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"
},