跳到主要内容

API设计-请求参数预定义

提示

API设计的主要作用是为了满足研发人员APIfirst的开发习惯,预先定义接口请求参数以及响应期望并生成 Mock URL,如果您仅仅需要调试接口,直接进 API调试 模块即可,无需在 API设计 模块预先定义。

预定义请求参数

支持header、query、body、认证四项,与API调试模块一致,共用同一份数据源。

Header 参数

你可以设置或者导入 Header 参数,cookie也在Header进行设置
Apipost有内置的系统header,当您不适用系统header而是使用自己设置的header时,关闭前边的小开关即可

image.png

Query 参数

Query 支持构造URL参数,同时支持 RESTful 的 PATH 参数(如图中 :uid

image.png

Body 参数

Body 提供三种类型 form-data / urlencoded(x-www-form-urlencoded) / raw ,每种类型提供三种不同的UI界面
1)当你需要提交表单时,切换到 urlencoded

image.png

2)当你需要提交有文件的表单时,切换到 form-data

image.png

3)当您需要发送JSON对象或者其他对象时,切换到对应的raw类型即可

image.png

提示

当入参为json和xml时,支持可视化结构的方式填写入参,如下图

image.png

认证

支持Bearer auth认证、Basic auth认证、Digest auth认证、OAuth 1.0、Hawk authentication、AWS Signature、NTLM Authentication [Beta]、Akamai EdgeGrid八种认证方式。

image.png