接口文档管理工具rap

git地址：  https://github.com/thx/RAP

wiki ： https://github.com/thx/RAP/wiki/home_cn

视频教程： http://thx.github.io/RAP/study.html

官方Demo地址： http://rap.taobao.org/org/index.do

 

什么是rap

1、工具帮助我们更高效的管理接口文档GUI工具

2、可以自动生成Mock数据、校验真实接口的正确性

3、结构化的API数据，避免更多重复劳动

 

 

用户场景：

前端，使用RAP制定接口，生成自测数据。

后端，使用RAP制定接口，校验真实输出的格式。

测试，使用RAP录制Mock规则，实现自动化测试。

其它，各种角色，需要了解该系统接口情况的人。

 

项目创建：

创建团队 和 创建项目的用户，就是该团队和用户的管理员 

团队  》》 产品线  》》 分组 》》 项目

注意： 添加项目时候  先在团队里面添加好成员

 

接口编辑和定义

 

参数或接口的复制与移动

可以 Ctrl+Enter 复制局部接口

 

版本控制

json导入

Mock数据自动生成

 

 

获取mock数据 前端同学可以先做事

RAP项目搭建环境

1、JDK 1.8+  

2、MySQL 5.6.12+ 太老的MySQL运行initialize.sql会报多timestamp错误

3、Tomcat 8.*+ 不要用9alpha，alpha和beta

4、Redis 3.0+ 部署在本机，默认端口即可

 

如何使用RAP

1. 直接访问由作者维护的rap.taobao.org
2. 自己部署一个RAP服务器，参考最新Release部分

快速上手 quick guide

• English: Quick Guide Manual at first.
• 中文：Video Tutorial 视频教程

分支说明

• master: 最新代码会在master，所以master是最新的，但是不保证稳定。且有一些公司自用的东西，所以提交记录可以参考，但不能直接使用master分支。
• release：是相对稳定的最新代码分支，也是RAP对外打包的分支
• 其它分支：根据开发需要，大的版本会以版本号为分支名，打一些临时分支。

最新Release

• Release
• 如何部署RAP服务器
• 如何使用RAP编辑文档

其它LINKS

• 我想大概了解RAP => Official Site 官网
• 我想查找详细的文档资料 => Wiki/Documents/Manual 文档/手册
• 我想快速了解什么是RAP => 视频介绍
• 我想快速上手RAP使用方法 => 视频教程
• 我要反馈问题 => Issues

如不想自己内部搭建接口文档管理工具：

1、http://www.xiaoyaoji.com.cn/

在线post，get请求，生成markdown 文档。

1、http://ouapi.com/