x-apigateway-backend.parameters
Significado: definição de serviço de back-end da API.
Escopo do efeito: x-apigateway-backend
Exemplo:
paths:
'/users/{userId}':
get:
produces:
- "application/json"
parameters:
- name: "X-Auth-Token"
description: "Authentication token"
type: "string"
in: "header"
required: true
- name: "userId"
description: "Username"
type: "string"
in: "path"
required: true
responses:
default:
description: "default response"
x-apigateway-request-type: "public"
x-apigateway-backend:
type: "HTTP"
parameters:
- name: "userId"
value: "userId"
in: "query"
origin: "REQUEST"
description: "Username"
- name: "X-Invoke-User"
value: "apigateway"
in: "header"
origin: "CONSTANT"
description: "Caller"
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
name |
Sim |
String |
Nome do parâmetro, que consiste em um máximo de 32 bytes, começando com uma letra. Somente letras, dígitos, pontos (.), hifens (-) e sublinhados (_) são permitidos. Os nomes dos parâmetros de cabeçalho não diferenciam maiúsculas de minúsculas. |
|
value |
Sim |
String |
Valor de parâmetro, que é um nome de parâmetro se o parâmetro vier de uma solicitação. |
|
in |
Sim |
String |
Localização do parâmetro, que pode ser header, query ou path. |
|
origin |
Sim |
String |
Origem do mapeamento do parâmetro. As opções incluem REQUEST e CONSTANT. |
|
description |
Não |
String |
Significado do parâmetro. |