新建项目

注意事项

 

编辑项目

注意事项
  1. 退出,指的是退出当前项目,退出后在列表中看不到该项目,其他成员依然可以看到
  2. 删除,指的是删除项目本身,删除后项目中的所有成员都看不到,只有管理员才有该权限,慎用

编辑项目基本信息

管理项目成员

步骤说明
  1. 新增成员,通过邮件邀请,邀请者注册登陆后点击邀请链接加入项目
  2. 编辑成员,目前角色只有"管理员"和"访客"两种,其中只有"管理员"才有编辑权限,默认邀请的角色为"访客"
  3. 移除成员,可移除人员成员,必须保证至少要有一名角色为"管理员"成员
注意事项
  1. 成员角色的改变在下次登陆后生效

编辑API文档

注意事项
  1. 访问主机,可配置为外网,局域网或本机ip,因为测试是基于本地的ajax请求, 所以只要API所在服务器处理好跨域请求都支持网站在线测试API

模块管理

步骤说明
  1. 主要用于对API接口进行分类,可以不设置,默认全部在"default"组下面
注意事项
  1. API文档预览展示的模块顺序为升序,如需按要求排序可在模块名称前加序号指定

编辑数据结构

步骤说明
  1. 数据结构主要用于固定格式的服务器响应结构,适用于多个接口可能返回相同的数据结构,编辑保存后相关的引用都会变更。
  2. 支持的数据类型说明如下:

    • string:字符串类型
    • array:数组类型,可创建复合结构
    • object:对象类型,可创建复合结构
    • int:短整型
    • long:长整型
    • float:浮点型
    • double:浮点型
    • decimal:精确到比较高的浮点型
    • ref:引用类型,即引用定义好的数据结构

 

 

接口管理

编辑接口基本信息

注意事项
  1. "请求url"和"请求方式"两者唯一确定一个接口,不能重复

编辑接口请求参数

步骤说明
  1. 参数位置说明如下:

    • body:http请求body
    • cookie:本地cookie
    • formData:表单参数
    • header:http请求header
    • path:http请求url,如getInfo/{userId}
    • query:http请求拼接,如getInfo?userId={userId}
  2. 参数类型说明如下:

    • 参考"编辑数据结构"步骤中的参数类型说明
    • 自定义:目前仅支持自定义json格式,仅当"参数位置"为“body"有效

 

 

编辑接口响应信息

步骤说明
  1. 数据类型说明如下:

    • 参考"编辑数据结构"步骤中的参数类型说明
    • 自定义:目前仅支持自定义json格式,仅当"参数位置"为“body"有效
注意事项
  1. 指定默认响应时,只需将响应"名称"设置为"default"即可

 

mock设置

步骤说明
  1. 接口响应配置相关的mock信息:

    • 静态数据:目前支持json格式数据,每次mock返回填写的固定数据
    • mock规则:调用返回的mock数据为根据规则动态生成,规则同mockjs规则。
  2. mock请求url:{web.base.url}/pass/mock/{docId}/{path},其中

    • {web.base.url}:网站访问基路径,如http://www.sosoapi.com
    • {docId}:请求的mock接口对应的文档id
    • {path}:请求的mock接口的"请求url"

    sosoapi-demo mock示例:

    新增用户接口:/user/simple/add.htm

    • http://www.sosoapi.com/pass/mock/1/user/simple/add.htm
    • http://www.sosoapi.com/pass/mock/1/user/simple/add.htm?name=123

    查询用户接口:/user/simple/{userId}/info.htm

    • http://www.sosoapi.com/pass/mock/1/user/simple/123/info.htm
    • http://www.sosoapi.com/pass/mock/1/user/simple/123/info.htm?name=123
注意事项
  1. 默认mock返回的数据为接口响应中名称为"200"或"default"或设置为默认的响应所对应的mock数据,如果有多个,则按取最近的一个
  2. 如果需要返回指定的响应mock数据可通过添加参数"mockRespCode"为指定的响应名称即可
  3. 默认mock是根据请求url和请求方式去匹配对应的接口,如果出现无法匹配情况,可通过添加参数"mockInterId"指定具体接口
  4. mock请求url可按实际需要的参数进行传递,建议将请求基路径设置为变量,方便后续环境切换
  5. 在线版本的mock已添加跨域处理,无论web前端或app前端可直接调用。

 

增值服务

说明
  1. 因网站的运营需要,后续版本会陆续新增增值服务功能。目前为试用阶段,试用期间免费。目前增值服务功能如下:

    • 项目导入功能
    • mock功能