x-apigateway-backend.parameters
含义:API网关定义的API后端参数定义。
示例:
paths:
'/users/{userId}':
get:
produces:
- "application/json"
parameters:
- name: "X-Auth-Token"
description: "认证token"
type: "string"
in: "header"
required: true
- name: "userId"
description: "用户名"
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: "用户名"
- name: "X-Invoke-User"
value: "apigateway"
in: "header"
origin: "CONSTANT"
description: "调用者"
|
参数 |
是否必选 |
类型 |
说明 |
|---|---|---|---|
|
name |
是 |
String |
参数名称,长度不能超过32个字节,由字母、数字、下划线、连线或点组成,且必须以字母开头。 header位置的参数名称不区分大小写。 |
|
value |
是 |
String |
参数值,当参数来源为REQUEST时,值为请求参数名称。 |
|
in |
是 |
String |
参数位置,支持header、query、path。 |
|
origin |
是 |
String |
参数映射来源,支持REQUEST、CONSTANT。 |
|
description |
否 |
String |
参数含义描述。 |