你不得不知的幾款經常使用的在線API管理工具

在項目開發過程當中，總會涉及到接口文檔的設計編寫，以前使用的都是ms office工具，不夠漂亮也不直觀，變動頻繁的話維護成本也更高，及時性也是大問題。基於這個背景，下面介紹幾個經常使用的API管理工具，方便你與調用方更高效的溝通測試：

Swagger

官網地址：https://swagger.io Swagger 是一款RESTFUL接口的文檔在線自動生成+功能測試功能軟件，是一個規範和完整的框架，標準的，語言無關，用於生成、描述、調用和可視化 RESTful 風格的 Web 服務。整體目標是使客戶端和文件系統做爲服務器以一樣的速度來更新。文件的方法，參數和模型緊密集成到服務器端的代碼，容許API來始終保持同步。Swagger 讓部署管理和使用功能強大的API從未如此簡單。

目前最新版本是V3，SwaggerUI是一個簡單的Restful API 測試和文檔工具。簡單、漂亮、易用。經過讀取JSON 配置顯示API. 項目自己僅僅也只依賴一些 html,css.js靜態文件. 你能夠幾乎放在任何Web容器上使用。

RAP

官網地址：http://rapapi.org/org/index.do

RAP來自阿里巴巴，是一個可視化接口管理工具 經過分析接口結構，使用mock動態生成模擬數據，校驗真實接口正確性， 圍繞接口定義，經過一系列自動化工具提高咱們的協做效率。能夠在線使用，也能夠選擇本地部署。一個GUI的WEB接口管理工具。在RAP中，您可定義接口的URL、請求&響應細節格式等等。經過分析這些數據，RAP提供MOCK服務、測試服務等自動化工具。RAP同時提供大量企業級功能，幫助企業和團隊高效的工做。

在先後端分離的開發模式下，咱們一般須要定義一份接口文檔來規範接口的具體信息。如一個請求的地址、有幾個參數、參數名稱及類型含義等等。RAP 首先方便團隊錄入、查看和管理這些接口文檔，並經過分析結構化的文檔數據，重複利用並生成自測數據、提供自測控制檯等等... 大幅度提高開發效率。

APIDOC

GitHub 地址：https://github.com/apidoc/apidoc

APIDOC能夠根據代碼註釋生成WEB API文檔，支持大部分主流開發語言，Java、javascript、php、erlang、perl、python、ruby等等，相對而言，web接口的註釋維護起來更加方便，不須要額外再維護一份文檔。APIDOC從註釋生成靜態html網頁文檔，不只支持項目版本號，還支持API版本號。

操做步驟也是至關簡單，依據官網的操做指南完成一個簡單的示例。這是一個示例demo，感覺一下http://apidocjs.com/example_basic/

Spring REST Docs

官網地址：http://projects.spring.io/spring-restdocs/

Spring的文檔幫助產生RESTful的服務文檔。它結合了手寫文檔寫的asciidoctor和自動生成與Spring MVC測試生成的片斷。這種方法可讓你突破Swagger那樣的工具產生的文件的侷限性。它能夠幫助你製做文件，準確，簡潔，結構良好。生成的文檔，可讓你的用戶獲得一個最低限度的他們所須要的信息。

其它

除了上面介紹到一些開源或免費的API管理工具，國內外一樣也有一些公司在作這個事情，根據使用需求作好選型便可，適合本身的纔是最好的。