跳到主要内容

API设计能做什么?

提示

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

API设计用于在接口还没开发完成时,预定义接口请求参数和响应期望(Mock),并自动生成 Mock URL,让前端和测试提前进入研发流程。

预定义请求参数和响应期望

1.我们可以在API设计模块预定义接口的 请求参数响应期望(Mock),方便前端提前对接。如下图:

image.png

在mock下获取mockurl:

image.png

校验实际响应结果

2.当接口开发完成,准备进行调试时,我们也可以用在API设计中建立的响应期望 校验实际响应结果 是否符合预期。

image.png