|
Parameter |
Type |
Description |
Example |
|---|---|---|---|
|
object |
HttpApiRequestContract |
||
| headerParameters |
array |
The request header parameters. |
|
| HttpApiParameter |
The parameter definition. |
||
| queryParameters |
array |
The query parameters. |
|
| HttpApiParameter |
The parameter definition. |
||
| pathParameters |
array |
The path parameters. |
|
| HttpApiParameter |
The parameter definition. |
||
| body |
object |
The body parameters. |
|
| description |
string |
The parameter description. |
body参数描述 |
| example |
string |
The sample value. |
{"result":"ok"} |
| contentType |
string |
The content type of the request body. |
application/json |
| jsonSchema |
string |
The JSON schema of the request body. |
{ "type": "object", "required": [ "result" ], "properties": { "result": { "type": "string", "description": "操作结果，'ok' 表示成功" } } } |