初窺 RAP：如何使用 RAP 進行接口文檔管理

Jason 豈安科技前端研發工程師

三年互聯網前端開發經驗，曾參與過多個系統框架的搭建和組件開發，負責豈安科技產品的數據可視化和公用組件開發。

1前言

RAP 是一個可視化接口管理工具， 經過分析接口結構，動態生成模擬數據，校驗真實接口正確性， 圍繞接口定義，經過一系列自動化工具提高咱們的協做效率。
在 RAP 中，您可定義接口的 URL、請求和響應細節格式等等。經過分析這些數據，RAP 提供 MOCK 服務、測試服務等自動化工具。

2爲何要選擇 RAP？

輕鬆編輯和分享

可視化編輯，完善的版本控制，各類格式的導入導出。讓先後端約定接口的工做變得十分簡單。

Mock服務

RAP會自動根據接口文檔生成Mock接口，這些接口會自動生成模擬數據，並支持複雜的生成邏輯。

實力的保障

覆蓋阿里幾乎全部部門，有數百家公司正在使用RAP，歷經4年積累大量經驗，可適應各類複雜的業務場景。

3開始 RAP

1輕鬆編輯和分享

要求環境：
✦ JDK 1.8+
✦ MySql 5.6.12+
✦ Tomcat 8.*+
✦ Redis 3.0+

RAP的部署方式有兩種：
一種是直接採用阿里編譯好的 war 包，放入 tomcat 便可。
另外一種是獲取源碼後本身編譯，或者修改一些代碼、作一些個性化的功能以後編譯，而後打成 war 包再放入 tomcat。
具體搭建方法參考官方文檔：
https://github.com/thx/RAP/wi...

2註冊 RAP 帳號，建立團隊和項目

部署到本身服務器上以後，先註冊帳號後登陸，而後建立團隊和項目。

建立以後能夠修改項目和添加項目成員，項目成員能夠訪問該項目的內容和添加修改接口。

3編寫接口文檔

登陸帳號後在首頁，能夠看到「個人項目」，選擇一個項目點擊進入，就能夠開始編寫咱們的接口文檔了。
進入頁面後點擊編輯，能夠看到以下界面：

咱們能夠將咱們的接口文檔寫在這個地方，備註中能夠寫出模擬的數據格式，具體規則參考官網用戶手冊：
https://github.com/thx/RAP/wi...
咱們能夠定義接口返回固定的字符串、返回隨機數，甚至定義方法根據傳參作一些處理以後再返回。

4使用接口

一直看到這裏，你們可能有疑問，這個文檔寫出來，好像和普通的文檔沒有什麼區別啊，甚至更加繁瑣。這裏咱們就要說到RAP與其餘文檔不一樣的地方：
寫完文檔以後，咱們能夠直接調用接口來返回數據，這些數據是根據咱們編寫的規則動態生成的，前端不須要等到後臺開發好接口以後再調用，而是能夠和後臺同步開發 。
咱們來看看返回的數據吧：

這裏能夠模擬請求來看返回的數據是不是本身想要的結果，肯定沒有問題以後，咱們就可使用該接口了。由於後臺工具暫時還不成熟，因此該處咱們介紹一下前端如何使用該接口：

✫ 前端調用接口時，host 和 url 與日常調用有所不一樣，如上圖，請求的 url 爲右下方的 url（並始終爲 get 請求，不管接口是 post 仍是其餘的 method），而返回的內容也並非返回的對象，而是文檔轉換成的一串字符串。

✫ 在這裏咱們須要安裝 mockjs，用於解析接口返回的內容（安裝方法參考： https://github.com/nuysoft/Mo...）

✫ 拿到接口返回的內容後，使用 const result = eval((${res})) ; 解析返回內容，而不是使用 JSON.parse，緣由是文檔中編寫的內容可能有 function，不能使用 JSON.parse 去轉換。解析完成後使用 const data = mockjs.mock(result) ; 這時候變量 data 就是咱們須要的數據了，也就是圖中所返回的結果。

✫ 經過上面三步，咱們就能夠拿到數據去寫咱們的代碼了。

4結束語

RAP 的基礎用法，看完上面的內容咱們能夠了解的差很少了，缺點也比較明顯，調用接口時比較麻煩，可是咱們能夠經過封裝請求方法來減小麻煩程度。總的來講 RAP 平臺仍是比較實用的。

目前RAP1已經中止更新，官方開始推行 RAP2，界面更加簡潔易用，可是沒有什麼文檔，大部分文檔仍是使用的 RAP1 的文檔（也就是今天咱們介紹的 RAP 平臺）。

RAP的介紹，到這裏也就告一段落了，若是你們比較感興趣能夠去官方部署的 RAP 平臺（http://rap.taobao.org/org/ind...）用用看，全部功能和本身部署的是如出一轍的，你們能夠先用用看，若是以爲還不錯，就能夠部署在本身的服務器上使用了。