現(xiàn)在越來(lá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上編寫或者導(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)目整體的開發(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)敏捷開發(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è)置人員讀寫權(quán)限鸳慈,3. 支持成員昵稱饱溢,4. 支持通過(guò)鏈接邀請(qǐng)成員。
- 專業(yè)版:1. 強(qiáng)大的插件支持蝶涩,2. 代碼生成理朋,3. 測(cè)試用例,4. 空間日志绿聘,5. 高級(jí)權(quán)限管理嗽上,6. 5天 * 10小時(shí) 專業(yè)客戶成功部門一對(duì)一支持。
網(wǎng)址:https://www.eolinker.com/#/
3.MinDoc
MinDoc 是一款針對(duì)IT團(tuán)隊(duì)開發(fā)的簡(jiǎn)單好用的文檔管理系統(tǒng)熄攘。MinDoc 的前身是 SmartWiki 文檔系統(tǒng)兽愤。SmartWiki 是基于 PHP 框架 laravel 開發(fā)的一款文檔管理系統(tǒng)。因 PHP 的部署對(duì)普通用戶來(lái)說(shuō)太復(fù)雜挪圾,所以改用 Golang 開發(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)目公開狀態(tài),私有項(xiàng)目需要通過(guò)Token訪問(wèn)何暇。
- 站點(diǎn)配置陶夜,二次開發(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é)作工具艰管,極致的文檔編寫體驗(yàn)滓侍,加快開發(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 文件格式編寫卜高,強(qiáng)大的官方支持醉冤,官方提供 atom 插件秩霍,支持語(yǔ)法智能提示及校驗(yàn),編寫快速簡(jiǎn)單蚁阳。
主要功能
- 支持 examples
- 支持 schema 校驗(yàn)
- 支持工具測(cè)試
網(wǎng)址:https://raml.org/
5.其他工具
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
4.APIJSON:
客戶端可以定義任何JSON結(jié)構(gòu)去向服務(wù)端發(fā)起請(qǐng)求,服務(wù)端就會(huì)返回對(duì)應(yīng)結(jié)構(gòu)的JSON字符串,所求即所得。
網(wǎng)址:http://jsonapi.org/
作者:每一天為明天168
鏈接:http://www.reibang.com/p/d7b13670e0eb
來(lái)源:簡(jiǎn)書
著作權(quán)歸作者所有峡谊。商業(yè)轉(zhuǎn)載請(qǐng)聯(lián)系作者獲得授權(quán)茫虽,非商業(yè)轉(zhuǎn)載請(qǐng)注明出處。