#if(api.description)
接口描述
#end
#if(api.interface_status)
接口状态
- #(api.interface_status??)
#end
#if(api.request_url)
请求URL
#end
#if(api.request_mode)
请求方式
#end
#if(api.headers_json && api.headers_json.size()>0)
Header
| header |
必选 |
示例值 |
类型 |
说明 |
#for(data:api.headers_json??)
#if(data.name==''||data.disable==false)
#continue
#end
| #(data.name??) |
#(data.type??) |
#(data.value??) |
#(data.require == '1' ? '是' : '否') |
#(data.remark??) |
#end
#end
#if(api.query_json && api.query_json.size()>0)
Query参数
| 参数名 |
类型 |
示例值 |
必选 |
说明 |
#for(data:api.query_json??)
#if(data.name==''||data.disable==false)
#continue
#end
| #(data.name??) |
#(data.type??) |
#(data.value??) |
#(data.require == '1' ? '是' : '否') |
#(data.remark??) |
#end
#end
#if(api.path_json && api.path_json.size()>0)
Path参数
| 参数名 |
类型 |
示例值 |
必选 |
说明 |
#for(data:api.path_json??)
#if(data.name==''||data.disable==false)
#continue
#end
| #(data.name??) |
#(data.type??) |
#(data.value??) |
#(data.require == '1' ? '是' : '否') |
#(data.remark??) |
#end
#end
#if(api.form_data_json && api.form_data_json.size()>0 && (api.request_body_type=='x-www-form-urlencoded'||api.request_body_type=='form-data'))
Body参数
#(api.request_body_type=='form-data'?'multipart':'application')/#(api.request_body_type??)
| 参数名 |
类型 |
示例值 |
必选 |
说明 |
#for(data:api.form_data_json??)
#if(data.disable==false)
#continue
#end
| #(data.name??) |
#(data.type??) |
#(data.value??) |
#(data.require == '1' ? '是' : '否') |
#(data.remark??) |
#end
#end
#if(api.request_body!='' && (api.request_body_type=='json' || api.request_body_type=='xml'))
Body参数 application/#(api.request_body_type??)
#(api.request_body)
Body字段说明
| 参数名 |
类型 |
必选 |
说明 |
#for(data:api.body_json)
| #(data.name??) |
#(data.require == '1' ? '是':'否') |
#(data.type??) |
#(data.remark??) |
#end
#end
#if(api.success_demo)
成功返回示例
#(api.success_demo??)
成功返回示例的参数说明
| 参数名 |
类型 |
说明 |
#for(data:api.success_data_explain??)
| #(data.name??) |
#(data.type??) |
#(data.remark??) |
#end
#end
#if(api.failuer_demo)
失败返回示例
#(api.failuer_demo??)
失败返回示例的参数说明
| 参数名 |
类型 |
说明 |
#for(data:api.failuer_data_explain??)
| #(data.name??) |
#(data.type??) |
#(data.remark??) |
#end
#end
#if(api.request_remark)
备注
#end