API设计能做什么?
提示:
API设计的主要作用是为了预先定义接口请求参数以及响应期望并生成 Mock URL,如果您仅仅需要调试接口,直接进 API调试 模块即可,无需在 API设计 模块预先定义。
API设计用于在接口还没开发完成时,预定义接口请求参数和响应期望(Mock),并自动生成 Mock URL,让前端和测试提前进入研发流程。
一、预定义请求参数和响应期望
我们可以在Apipost的API设计模块预定义接口的 请求参数 和 响应期望(Mock),方便前端提前对接。如下图:
二、校验实际响应结果
当接口开发完成,准备进行调试时,我们也可以用在API设计中建立的响应期望 校验实际响应结果 是否符合预期。
API设计-请求参数预定义
预定义请求参数
支持header、query、body、认证四项,与API调试模块一致,共用同一份数据源。
Header 参数
你可以设置或者导入 Header 参数,cookie也在Header进行设置
Query 参数
Query 支持构造URL参数,同时支持 RESTful 的 PATH 参数(如图中 :uid)
Body 参数
Body 提供三种类型 form-data / x-www-form-urlencoded / raw ,每种类型提供三种不同的UI界面 1)当你需要提交表单时,切换到 x-www-form-urlencoded
2)当你需要提交有文件的表单时,切换到 form-data

最低0.47元/天 解锁文章

被折叠的 条评论
为什么被折叠?



