在專案開發過程中，總會涉及到介面文件的設計編寫，之前使用的都是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管理工具，國內外同樣也有一些公司在做這個事情，根據使用需求做好選型即可，適合自己的才是最好的。