MOCK接口管理系统使用说明

Mock接口管理是一个可视化的接口管理工具,提供接口文档搭建和动态生成模拟数据等功能,为高效的前后端协作开发提供帮助。

Mock接口管理系统地址:http://mock.showjoy.net

系统用户权限说明

本系统登陆环境和尚妆线下登陆环境保持一致,拥有尚妆线下环境 - 后台管理权限(USER-ADMIN)的尚妆用户可以登陆本系统并进行功能的使用。

接口文档创建

所有登陆系统的用户都可以进行接口文档的创建,通过页面头部添加接口入口可以进入文档创建页面。 接口文档创建包含如下内容项:

  • 接口名称 : 接口名称为接口地址,唯一存在
  • 接口描述 : 针对接口功能进行描述
  • 请求类型 : 接口的请求方式/提交方式
  • 返回值类型 : 返回JSON/JSONP类型
  • 传递数据 : 接口请求参数定义
  • 返回数据 : 接口响应数据定义

接口传递数据定义和返回数据定义的方式相同,系统接入jsoneditor插件进行数据的定义,操作界面如下图所示: 该插件提供不同数据定义展示模式,包括json式数据输入界面化的数据定义,可根据需求使用。

Mock语法规范说明

在接口数据定义完成后需要进行数据描述数据Mock规则的制定。 Mock规则定义了该字段数据的动态模拟方式,系统提供了常用Mock规则的选择方式和用户自定义Mock规则的方式。

注:采用自定义方式需要完整输入Mock规则 : 'name|rule': value

详细Mock语法规范说明参考:https://github.com/nuysoft/Mock/wiki

接口模拟说明

完成上述文档创建流程后将进入接口文档页面, 并可以根据接口文档内容进行接口的模拟。 接口模拟的链接:http://mock.showjoy.net/interface/mock/mock?api= + 接口名

后续功能说明(欢迎补充)

  • 接入业务环境数据,提供真实业务环境模拟。
  • 接入JSON SCHEMA规范,提供接口鉴定功能。
  • 搭建本地请求拦截服务,简化接口模拟方法。
  • 快速添加当前已有接口,简化已有接口文档搭建方法。
  • 添加接口响应状态,提供多状态的返回方式(可自定义)。
  • 创建项目分类,在开发项目复用到已有接口时直接加入项目,提高效率。
  • ……

悟空

前端开发码农一枚,爱摄影,爱旅游