介紹幾款常用的在線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管理工具，國內外同樣也有一些公司在做這個事情，根據使用需求做好選型即可，適合自己的才是最好的。

• 學習新技術時你應當掌握的『最少必要知識』
• 無限逼近你的問題終點
• 程序員，保護你的好奇心和求知慾
• 怎麼定位自己在團隊里的角色
• 軟體生命周期與技術人的職業周期
• 程序員，只產出代碼是遠遠不夠滴
• 踏實做事，也要抬頭看路
• 知道的越多，越感覺無知
• 你的經歷不一定都能變成經驗
• Spring Boot + Elasticsearch 實現大批量數據集下中文的精確匹配
• Spring Boot + Elasticsearch 實現索引批量寫入
• Spring Boot + Elasticsearch 實現索引的日常維護
• 野蠻生長的前端，從雜牌軍到正規軍
• 微服務體系下如何快速構建一個服務
• 介紹幾款常用的在線API管理工具
• 你不得不知的幾個互聯網ID生成器方案
• 基於SpringCloud的Microservices架構實戰案例-序篇
• 程序員，保護你的好奇心和求知慾

推薦閱讀：