api 接口管理工具
api 接口管理工具
如今，Web 應用的先後端分離事實上已經成爲了你們都承認的一種開發方式，先後端分離以後，前端與後端都用接口（api）來溝通，這就須要咱們作好 API 接口管理，因此，此次來聊聊 API 接口管理工具。前端
API 接口管理工具大體分爲線上工具和自建工具。java
1. 線上工具
比較熱門的線上工具備：node
2. 自建工具
企業通常都採用自建工具，本身維護一套 API 接口管理工具，比較熱門的有：git
- yapi：去哪兒出品，線上演示地址 http://yapi.demo.qunar.com
- RAP / rap2-delos + rap2-dolores：阿里出品，線上演示地址 http://rap2.taobao.org/
- easy-mock：線上演示地址 https://easy-mock.com/
- swagger：國外比較熱門的接口管理工具
2.1 yapi
環境需求：Node.js (>= v7.6) & MongoDB (>= v2.6) & Git
yapi UI 很漂亮，操做很流暢，安裝比較簡單，使用也比較簡單，不與其餘第三方工具或語言綁定。github
若是喜歡簡單、UI 友好的，推薦使用這個。後端
安裝：yapi#安裝api
2.2 RAP / rap2-delos + rap2-dolores
環境需求：Node.js (>= v8.9) & MySQL (>= v5.7) & Redis（>= v4.0）
rap 功能很是全，UI 不是很漂亮，安裝比較複雜，使用也比較複雜，數據生成使用 mock.js。服務器
若是對功能完善、系統穩定、用 mock.js 生成數據有偏好的，推薦使用這個。markdown
RAP 目前有兩個版本，第一個版本的 RAP 已經被官方廢棄了，建議用第二個版本。前後端分離
RAP2 分紅了兩個包：
- rap2-delos：後端數據 API 服務器
- rap2-dolores：前端靜態資源
RAP2 的安裝步驟要麻煩一些，rap2-delos 能夠參考官方文檔 rap2-delos#部署、非官方rap2-delos部署文檔，rap2-dolores 能夠參考官方文檔 rap2-dolores#deployment-部署。
2.3 easy-mock
環境需求：Node.js (>= v8.9) & MongoDB (>= v3.4) & Redis（>= v4.0）
easy-mock UI 很漂亮，操做很流暢，安裝比較簡單，使用也比較簡單，數據生成使用 mock.js，而且支持導入 Swagger Docs API。
若是喜歡簡單、UI 友好的，而且喜歡用 mock.js 生成數據或者導入 Swagger Docs API 的，推薦使用這個。
2.4 swagger
Swagger 其實並非一個工具，而是一系列工具，或者說叫一個生態：
- OpenAPI-Specification：基於
yaml語法格式定義的一套開放 API 文檔規範 - swagger-ui：UI 展現庫
- swagger-codegen：根據 Swagger 定義的 RESTful API 自動生成 Swagger 文檔（for java）
- swagger-core：java 核心庫
- swagger-editor：可視化編輯器
- ReDoc：生成格式優美的 UI 界面（第三方）
- swagger-node：for node.js
- go-swagger：for Go
如你所見，這個生態功能很是全，但使用很是複雜，入門坎比較高。
這套工具對後端很是有用，特別是 java 開發，能直接根據註釋自動生成相應的 API 規範文檔，而後直接根據這個 API 規範文檔自動生成 UI 可視化界面與數據 Mock 服務器，而不是咱們手動建立。
安裝：swagger
3. 其餘工具
上面講的，無論是線上工具仍是自建工具，都是接口集成工具，主要是爲了提供數據 Mock 功能。
若是僅僅是爲了以靜態文本的形式作展現用，能夠試試下面的一些工具：
3.1 Git 倉庫 + Markdown
把接口文檔單獨建一個項目，使用 Markdown 的格式來書寫。
3.2 leanote
相似網易雲筆記、印象筆記的筆記管理工具。
3.3 gollum
基於 Git 的 wiki 系統。
3.4 wiki.js
基於 Node.js 的 wiki 系統。
後續
更多博客，查看 https://github.com/senntyou/blogs
版權聲明：自由轉載-非商用-非衍生-保持署名（創意共享3.0許可證）