接口文檔管理工具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/