先後端分離，幾個經常使用的API管理系統

 爲啥須要API管理系統！ 

互聯網服務發展至今，做爲開發者陣營的咱們，已經用實踐證實了先後端分離開發模式正在逐漸成爲愈來愈多互聯網公司構建服務和應用的方式。

先後端分離優點多多，其中一個很重要的優點是：對於後臺服務（系統）來說，只需提供一套統一的API接口，可被多個客戶端所複用，分工和協做被細化，大大提升了效率。

與此同時帶來的一些反作用即是：

• 接口文檔管理混亂。以前不少公司管理API接口，有用Wiki的，有Word文檔的，有Html的，常常遇到問題是接口因變了，好比增長參數，參數名變了，參數被刪除了等都沒有及時更新文檔的狀況

• 接口測試沒有保障。畢竟前端開發依賴後端接口，若是先後端開發不一樣步，接口及時測試成了問題，所以須要隨時提供一套可用的API接口數據測試服務。

• 資源分散，難以共享。每一個開發者維護本身的一套測試接口集合，沒法共用他人接口集合，開發過程當中充斥着大量重複造數據、填接口的工做，效率不高

• 其餘問題。除此以外還有可能碰到諸如 文檔導出、接口分類規劃、操做便利性等一系列問題。

基於此狀況，所以本文接下來就來推薦幾個經常使用的 API管理系統，幫助先後端分離開發模式下提高效率和可靠性，總有一個你看得上！

---

 YApi （推薦）

YApi 是高效、易用、功能強大的 api 管理平臺，旨在爲開發、產品、測試人員提供更優雅的接口管理服務。它能夠幫助開發者輕鬆建立、發佈、以及維護API。除此以外，YApi 還爲用戶提供了優秀的交互體驗，開發人員只需利用平臺提供的接口數據寫入工具以及簡單的點擊操做就能夠實現接口的管理。

功能特性：

• 基於 Json5 和 Mockjs 定義接口返回數據的結構和文檔，效率提高多倍

• 扁平化權限設計，即保證了大型企業級項目的管理，又保證了易用性

• 相似 postman 的接口調試

• 自動化測試, 支持對 Response 斷言

• MockServer 除支持普通的隨機 mock 外，還增長了 Mock 指望功能，根據設置的請求過濾規則，返回指望數據

• 支持 postman, har, swagger 數據導入

• 免費開源，內網部署，信息不再怕泄露了

項目主頁： http://yapi.demo.qunar.com/

文檔：https://hellosean1025.github.io/yapi/documents/index.html

 

 

其餘一些管理工具：

---

一、eolinker 

eolinker也挺好用，UI好看，是一個開箱即用的API研發管理方案，0代碼實現API自動化

功能特性：

• 開箱即用的API研發管理方案：無需繁瑣的配置，支持讀取代碼註解生成API文檔，或者是經過UI界面快速建立全面的API文檔。經過Mock API、API變動通知、版本管理等服務，讓團隊更敏捷。

• 強大的「0代碼」API測試 / 自動化測試：全面支持HTTPS、Restful、Web Service等類型API。強大的API自動化測試和用例管理功能，讓你不寫代碼實現API自動化測試，實時生成測試報告，提升測試覆蓋率。

• 實用的團隊協做功能：提供強大的人員權限管理功能，你能夠爲不一樣的成員設置容許執行的操做，系統會自動記錄成員的全部操做日誌。而且能夠經過豐富的插件系統來擴展示有的系統功能。

• 開放的平臺設計：一鍵導入Postman、Swagger等產品數據，讓您快速享受到EOLINKER API Studio的服務。您還能夠經過Open API將EOLINKER API Studio對接到各種企業內部系統中，實現開發、測試、運維一體化。

• 支持離線的私有化部署：EOLINKER API Studio支持離線的私有化部署，產品以及數據均儲存在企業內部，您能夠根據部門/分公司設立相互隔離的工做空間，而且經過Open API對接Jenkins等各種持續集成系統。

項目主頁： https://www.eolinker.com/

---

二、ShowDoc 

ShowDoc 是一個很是適合IT團隊的在線文檔分享工具，它能夠加快團隊之間溝通的效率。免費開源！

支持以下特性：

• API文檔： 隨着移動互聯網的發展，BaaS（後端即服務）愈來愈流行。服務端提供API，APP端或者網頁前端即可方便調用數據。用 ShowDoc能夠很是方便快速地編寫出美觀的API文檔。

• 數據字典： 一份好的數據字典能夠很方便地向別人說明你的數據庫結構，如各個字段的釋義等。

• 說明文檔： 你徹底可使用showdoc來編寫一些工具的說明書,也能夠編寫一些技術規範說明文檔以供團隊查閱

項目主頁： https://www.showdoc.cc/

---

三、易文檔 

最後一個易文檔也是，從需求文檔、API文檔、部署文檔到使用手冊，支持多種定製文檔編輯器；同時也支持接口在線測試，一鍵生成文檔、調用示例、mock配置。

 項目主頁： https://easydoc.xyz/

---

 

四、Swagger

Swagger 是一個規範和完整的框架，用於生成、描述、調用和可視化 RESTful 風格的 Web 服務。它能夠方便地和 Spring MVC、Spring Boot等框架進行快速整合，而且經過結合諸如Swagger-UI等組件，將 controller層的方法進行方便地可視化展現，像方法註釋，方法參數，方法返回值等都提供了相應的用戶

項目主頁： https://swagger.io/

 

原文地址：https://mp.weixin.qq.com/s/Ahs6fnIfFVVPOn3NZpIsNA