user_manual

用户手册

RAP2是做什么的？

RAP2是时下流行的开发接口管理工具，通常用于前后端分离的开发模式中，共同约定接口，而RAP2可以根据约定的接口自动生成Mock数据、对后端接口进行校验，拥有较好的文档编写体验，支持复杂的Mock逻辑，为开发提供了便利。

RAP2 是参照RAP1 第一代的基础上，使用Node + React重构了所有主要功能。

基本使用

管理团队和仓库

完成注册和登陆后，首先需要创建仓库。RAP2中，不同的项目以 仓库 作为单位进行管理。每个仓库中可以保存一系列的接口和分组，仓库之间的数据可以通过 协作仓库 来进行串联及共享。

进入 主菜单 -> 团队 ，点击 新建团队 按钮，即可创建新的团队。团队分私有及公开两种权限，公开的内容所有注册用户可见（方便内网搭建用户共享项目数据，不用单独申请）。如果设置为私有，则只有团队成员可见该团队及所属的项目。填写好资料后即可保存，系统自动跳转至团队详情页。

点击 新建仓库 按钮即可创建新的仓库，仓库成员拥有仓库的编辑权限，团队成员但不是项目成员，拥有仓库的只读权限。RAP1老用户可以通过导入仓库功能，实现RAP1 -> RAP2的项目导入。

概念 / 词汇

• 仓库：即接口文档放置的仓库，可以包含多个接口文档
• 协同仓库：Mock服务协同仓库，在当前仓库中无法匹配到接口时，将会从协同仓库中寻找，便于大的项目按不同仓库拆分管理
• 团队：团队可包含多个仓库，用户可加入多个团队
• 插件：用于实现生成Mock数据、拦截真实I/O请求以Mock数据替换等功能的插件
• 平台API：以开放API形式将接口文档、Mock数据等内容，提供给外部调用
• Mock模板：Mock.js规则模板，用于生成Mock数据，模板中可定义丰富的规则以适应数据的按需随机性
• Mock数据：通过Mock模板生成的最终Mock数据

进阶使用

Mock语法

Mock.js语法规则

RAP2使用了Mock.js作为Mock引擎，详细语法规则请参考mockjs.com

如何引用请求参数？

在初始值中填写$参数名$，RAP2 Mock服务会根据实际的传参将其替换为实际传入值。例如字段param填写初始值$xxx$，当收到请求url?xxx=123时，实际返回值为{ "param": "123" }