效率工具:前端和後端的接口文檔工具統計和對比

下面介紹幾種經常使用的接口文檔工具:Rap二、ShowDoc、Swagger、Postman和Yapi。

自動生成接口文檔工具-Swagger的使用,請戳連接juejin.im/post/5db930…json

工具對比

工具和特色api

Rap2數組

ShowDoc工具

Swaggerpost

查看接口的易用性測試

查看參數,比較直觀接口

訪問地址一個,可查看全部產品。文檔

查看參數,比較直觀部署

訪問地址一個,可查看全部產品。get

參數不直觀,有的數據類型不通用。

若是有10個項目,就有10個訪問地址。

添加接口的快捷性

支持json導入

一、須要手動選擇接口所在的標題-二級目錄-三級目錄

二、對多層數據不能支持(例如參數中有數組)

須要給每一個參數添加關鍵字

自動更新文檔

不支持

不支持

支持

須要按照規範,添加代碼註釋,最後掃描生成文檔

在線接口測試

支持

支持

支持


其餘工具

還有Postman和Yapi。

Postman是客戶端。接口共享,有人數限制。超過人數須要付費。

Yapi的平臺網址yapi.demo.qunar.com。已開源,支持本地部署。


補充

Rap2的平臺網址是http://rap2.taobao.org。已開源,支持本非部署。 

相關文章
相關標籤/搜索