发送HTTP请求
API接口功能布局。
API请求参数
Header 参数
您可以设置或导入标头参数,cookie也在标头中设置。
Query 参数
查询支持URL参数和RESTful PATH参数(如:id)的构造。
Body 参数
Body提供了三种类型的表单-data/x-www-form-URL encoded/raw,每种类型都提供了三种不同的UI界面。
1)当需要提交表单时,切换到x-www-form-urlencoded。
2)当需要提交带有文档的表单时,切换到form-data。
3)当需要发送JSON对象或其他对象时,切换到对应的raw类型。
00-1010点击发送按钮后,如果有数据返回,将显示返回的数据、响应时间、响应代码和Cookie。
px 12px;">注意:返回数据默认是Pretty模式,便于查看 JSON XML 格式。您可以通过切换 原生 或 预览 模式 查看其它类型的类型。
点击分享文档
复制并打开文档地址就可以看到了完整的接口文档。
本文主要是讲解一些需要注意的事项。
请求参数的描述填写
对于header、query以及form-data和urlencode的body参数,我们在如下地方填写参数描述:
如图中所示,对于一个填写过的参数,我们可以在新建接口可以通过点击参数描述后面的♦️方块标志快速导入描述,不用重复打字。
对于raw类型的body参数,我们可以通过点击“提取字段和描述”来针对参数进行描述的填写:
对于已经填写过的参数,APIPOST会自动匹配描述,不用重复填写。
响应参数的描述填写
很多新手困惑为什么APIPOST分享的文档没有成功响应示例和错误响应示例,那是因为APIPOST不会把发送后的实时响应的数据作为响应示例。
您需要手动的将实时响应结果导入或者复制到对应的成功响应示例和错误响应示例。
字段描述的填写跟raw类型的body参数,我们可以通过点击“提取字段和描述”来针对参数进行描述的填写。
同样,对于已经填写过的参数,APIPOST会自动匹配描述,不用重复填写。
内容来源网络,如有侵权,联系删除,本文地址:https://www.230890.com/zhan/48438.html