| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| object | HttpApiRequestContract | ||
| headerParameters | array | 请求头参数定义。 | |
| HttpApiParameter | 请求头参数定义。 | ||
| queryParameters | array | Query 参数定义。 | |
| HttpApiParameter | Query 参数定义。 | ||
| pathParameters | array | 路径参数定义。 | |
| HttpApiParameter | 路径参数定义。 | ||
| body | object | 请求体参数定义。 | |
| description | string | 描述。 | body参数描述 |
| example | string | 示例值。 | {"result":"ok"} |
| contentType | string | 请求体内容类型。 | application/json |
| jsonSchema | string | 请求体 JSON 定义描述。 | { "type": "object", "required": [ "result" ], "properties": { "result": { "type": "string", "description": "操作结果，'ok' 表示成功" } } } |
文档内容是否对您有帮助？