現(xiàn)在越來(lái)越流行前后端分離開(kāi)發(fā)言询,使用ajax交互俯萎。所以api接口文檔就變的十分有意義了,目前市場(chǎng)有哪些比較優(yōu)秀的接口文檔管理工具呢运杭?
一鍵導(dǎo)入夫啊,點(diǎn)擊復(fù)制,方便快捷
鏈接地址:https://easydoc.xyz/
1.Showdoc:
一個(gè)非常適合IT團(tuán)隊(duì)的在線API文檔辆憔、技術(shù)文檔工具撇眯。
網(wǎng)址:https://www.showdoc.cc/
2.eoLinker
eoLinker擁有業(yè)內(nèi)最強(qiáng)的接口管理功能,無(wú)論你是創(chuàng)業(yè)團(tuán)隊(duì)還是成熟企業(yè)虱咧,eoLinker將滿足你的所有接口管理需求熊榛。在eoLinker上編寫(xiě)或者導(dǎo)入接口文檔,邀請(qǐng)團(tuán)隊(duì)成員加入項(xiàng)目彤钟,接著進(jìn)行在線的接口測(cè)試来候,并且提供Mock接口給前端進(jìn)行對(duì)接,后續(xù)通過(guò)完善的文檔版本管理以及團(tuán)隊(duì)協(xié)作功能逸雹,不斷地對(duì)項(xiàng)目進(jìn)行迭代,提高項(xiàng)目整體的開(kāi)發(fā)效率云挟!
主要功能
- 快速全面地管理接口文檔 :1.UI可視化文檔梆砸,2. 支持表單、RESTful园欣、Raw等設(shè)計(jì)規(guī)范帖世,3. 通過(guò)注釋生成文檔,4. 版本管理沸枯,5. 支持富文本/Markdown日矫,6. 分組管理,7. 星標(biāo)標(biāo)注绑榴。
- 測(cè)試接口是否正常運(yùn)作:1. 支持在線哪轿、本地(localhost)測(cè)試,2. 支持跨域測(cè)試翔怎,3. 支持文件測(cè)試窃诉,4. 強(qiáng)大的參數(shù)構(gòu)造器。
- Mock API實(shí)現(xiàn)敏捷開(kāi)發(fā):1. 根據(jù)文檔自動(dòng)生成校驗(yàn)數(shù)據(jù)赤套,2. 支持請(qǐng)求協(xié)議飘痛、請(qǐng)求方式校驗(yàn),3. 支持簡(jiǎn)易Mock容握、高級(jí)Mock(MockJS)宣脉,4. 支持跨域調(diào)用。
- **了解團(tuán)隊(duì)成員動(dòng)向: **1. 團(tuán)隊(duì)人員管理剔氏,,2. 支持設(shè)置人員讀寫(xiě)權(quán)限塑猖,3. 支持成員昵稱堪遂,4. 支持通過(guò)鏈接邀請(qǐng)成員。
- 專業(yè)版:1. 強(qiáng)大的插件支持萌庆,2. 代碼生成溶褪,3. 測(cè)試用例,4. 空間日志践险,5. 高級(jí)權(quán)限管理猿妈,6. 5天 * 10小時(shí) 專業(yè)客戶成功部門(mén)一對(duì)一支持。
網(wǎng)址:https://www.eolinker.com/#/
3.MinDoc
MinDoc 是一款針對(duì)IT團(tuán)隊(duì)開(kāi)發(fā)的簡(jiǎn)單好用的文檔管理系統(tǒng)巍虫。MinDoc 的前身是 SmartWiki 文檔系統(tǒng)彭则。SmartWiki 是基于 PHP 框架 laravel 開(kāi)發(fā)的一款文檔管理系統(tǒng)。因 PHP 的部署對(duì)普通用戶來(lái)說(shuō)太復(fù)雜占遥,所以改用 Golang 開(kāi)發(fā)俯抖。可以方便用戶部署和實(shí)用瓦胎,同時(shí)增加Markdown和HTML兩種編輯器芬萍。其功能和界面源于 kancloud 。
[](javascript:;)主要功能
- 項(xiàng)目管理搔啊,可以對(duì)項(xiàng)目進(jìn)行編輯更改柬祠,成員添加等。
- 文檔管理负芋,添加和刪除文檔漫蛔,文檔歷史恢復(fù)等。
- 用戶管理旧蛾,添加和禁用用戶莽龟,個(gè)人資料更改等。
- 用戶權(quán)限管理 锨天, 實(shí)現(xiàn)用戶角色的變更毯盈。
- 項(xiàng)目加密,可以設(shè)置項(xiàng)目公開(kāi)狀態(tài)绍绘,私有項(xiàng)目需要通過(guò)Token訪問(wèn)奶镶。
- 站點(diǎn)配置,二次開(kāi)發(fā)時(shí)可以添加自定義配置項(xiàng)陪拘。
- 附件管理厂镇,可管理所有項(xiàng)目中上傳的文件。
- 項(xiàng)目導(dǎo)出左刽,目前支持導(dǎo)出 PDF 格式項(xiàng)目捺信。
- 系統(tǒng)日志。
網(wǎng)址:https://www.iminho.me/
4.apizza
極客專屬的api協(xié)作管理工具 免費(fèi)的團(tuán)隊(duì)協(xié)作,在線模擬調(diào)試迄靠,快速生成api文檔秒咨,導(dǎo)出離線版文檔
主要功能
api跨域調(diào)試量身定制的chrome插件,本地掌挚,在線接口雨席,都可以調(diào)。
免費(fèi)的團(tuán)隊(duì)協(xié)作 免費(fèi)的團(tuán)隊(duì)協(xié)作工具吠式,極致的文檔編寫(xiě)體驗(yàn)陡厘,加快開(kāi)發(fā)效率。
安全的云端存儲(chǔ) 安全可靠的云端存儲(chǔ)服務(wù)特占,企業(yè)安全版支持本地?cái)?shù)據(jù)中心糙置。
一鍵分享 與團(tuán)隊(duì)共享你的API文檔。
支持Postman是目,Swagger格式 導(dǎo)入Postman/Swagger Json 生成文檔谤饭。
導(dǎo)出離線文檔 導(dǎo)出離線文檔,部署本地服務(wù)器懊纳。
api Mock 根據(jù)文檔自動(dòng)生成返回結(jié)果揉抵,提供獨(dú)立URL方便前端測(cè)試
支持多種文檔 http接口文檔,markdown說(shuō)明文檔
[圖片上傳中...(image.png-150c34-1539666393114-0)]
網(wǎng)址:http://apizza.cc/
5.RAML
用 YAML 文件格式編寫(xiě)长踊,強(qiáng)大的官方支持功舀,官方提供 atom 插件,支持語(yǔ)法智能提示及校驗(yàn)身弊,編寫(xiě)快速簡(jiǎn)單。
主要功能
- 支持 examples
- 支持 schema 校驗(yàn)
- 支持工具測(cè)試
網(wǎng)址:https://raml.org/
6.APIJSON:
客戶端可以定義任何JSON結(jié)構(gòu)去向服務(wù)端發(fā)起請(qǐng)求,服務(wù)端就會(huì)返回對(duì)應(yīng)結(jié)構(gòu)的JSON字符串,所求即所得列敲。
網(wǎng)址:http://apijson.cn
7. docway 接口文檔管理工具
網(wǎng)址:www.docway.net
其他工具
1.Swagger:
通過(guò)固定格式的注釋生成文檔. 省時(shí)省力,不過(guò)有點(diǎn)學(xué)習(xí)成本阱佛。
網(wǎng)址:https://swagger.io/
2.apidoc:
可以根據(jù)代碼注釋生成web api文檔,web接口的注釋維護(hù)起來(lái)更加方便戴而,不需要額外再維護(hù)一份文檔凑术。
網(wǎng)址:http://apidocjs.com/
3.RAP:
一個(gè)可視化接口管理工具 通過(guò)分析接口結(jié)構(gòu),動(dòng)態(tài)生成模擬數(shù)據(jù)所意,校驗(yàn)真實(shí)接口正確性淮逊, 圍繞接口定義,通過(guò)一系列自動(dòng)化工具提升我們的協(xié)作效率扶踊。
網(wǎng)址:http://rap.taobao.org/org/index.do