API 研发管理平台教程

帮助您规范、开发、测试您的 API

创建 Mock API

最近更新时间:2020-10-25

什么是Mock API

在瀑布流开发模式中,如果前端开发人员需要进行页面对接,需要后端先完成API的开发工作,因此前后端开发的进度会互相影响。

通过Mock API,您可以事先编写好API的数据生成规则,由系统动态生成API的返回数据。开发人员通过访问Mock API来获得页面所需要的数据,完成对接工作。

Mock API支持根据不同的请求参数返回不同的HTTP Status Code、Header、Body等数据。您可以在一个API文档里创建多个Mock API,模拟前端发起的各种请求,方便对前端逻辑进行校验。

当项目正式发布时,只需将 Mock API 的地址前缀替换为实际的访问地址即可。

因为同一个项目中的Mock API的地址前缀是相同的(如mock.eolinker.com/uasyd1/…),因此可以在代码中将Mock API的地址前缀作为全局变量,项目上线时仅需替换变量的值即可改变整个项目的 API 请求地址前缀。

创建Mock API

进入API文档详情页面,点击Mock标签,点击 添加Mock

在弹窗中填写Mock API的触发条件和返回结果。

触发条件支持请求头部、请求体(Form-data、JSON)、Query 参数等。以下例子表示当Form-data参数中包含 user_name = jackliu 时,返回预设的JSON字符串。

返回结果除了返回固定的任意内容之外,系统还可以根据您的接口文档自动生成返回结果,或者通过Javascript生成复杂的返回数据等,相关教程可以查看详细的Mock API教程