適合寫(xiě)api接口文檔的管理工具有哪些乡恕?

現(xiàn)在越來(lái)越流行前后端分離開(kāi)發(fā)言询,使用ajax交互俯萎。所以api接口文檔就變的十分有意義了,目前市場(chǎng)有哪些比較優(yōu)秀的接口文檔管理工具呢运杭?

一鍵導(dǎo)入夫啊,點(diǎn)擊復(fù)制,方便快捷

鏈接地址:https://easydoc.xyz/

image.png

image.png

1.Showdoc:

一個(gè)非常適合IT團(tuán)隊(duì)的在線API文檔辆憔、技術(shù)文檔工具撇眯。


image.png

網(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ā)效率云挟!


image.png
image.png

主要功能

  • 快速全面地管理接口文檔 :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 。


image.png

[](javascript:;)主要功能

  1. 項(xiàng)目管理搔啊,可以對(duì)項(xiàng)目進(jìn)行編輯更改柬祠,成員添加等。
  2. 文檔管理负芋,添加和刪除文檔漫蛔,文檔歷史恢復(fù)等。
  3. 用戶管理旧蛾,添加和禁用用戶莽龟,個(gè)人資料更改等。
  4. 用戶權(quán)限管理 锨天, 實(shí)現(xiàn)用戶角色的變更毯盈。
  5. 項(xiàng)目加密,可以設(shè)置項(xiàng)目公開(kāi)狀態(tài)绍绘,私有項(xiàng)目需要通過(guò)Token訪問(wèn)奶镶。
  6. 站點(diǎn)配置,二次開(kāi)發(fā)時(shí)可以添加自定義配置項(xiàng)陪拘。
  7. 附件管理厂镇,可管理所有項(xiàng)目中上傳的文件。
  8. 項(xiàng)目導(dǎo)出左刽,目前支持導(dǎo)出 PDF 格式項(xiàng)目捺信。
  9. 系統(tǒng)日志。

網(wǎng)址:https://www.iminho.me/

4.apizza

極客專屬的api協(xié)作管理工具 免費(fèi)的團(tuán)隊(duì)協(xié)作,在線模擬調(diào)試迄靠,快速生成api文檔秒咨,導(dǎo)出離線版文檔

image

主要功能

  1. api跨域調(diào)試量身定制的chrome插件,本地掌挚,在線接口雨席,都可以調(diào)。

  2. 免費(fèi)的團(tuán)隊(duì)協(xié)作 免費(fèi)的團(tuán)隊(duì)協(xié)作工具吠式,極致的文檔編寫(xiě)體驗(yàn)陡厘,加快開(kāi)發(fā)效率。

  3. 安全的云端存儲(chǔ) 安全可靠的云端存儲(chǔ)服務(wù)特占,企業(yè)安全版支持本地?cái)?shù)據(jù)中心糙置。

  4. 一鍵分享 與團(tuán)隊(duì)共享你的API文檔。

  5. 支持Postman是目,Swagger格式 導(dǎo)入Postman/Swagger Json 生成文檔谤饭。

  6. 導(dǎo)出離線文檔 導(dǎo)出離線文檔,部署本地服務(wù)器懊纳。

  7. api Mock 根據(jù)文檔自動(dòng)生成返回結(jié)果揉抵,提供獨(dú)立URL方便前端測(cè)試

  8. 支持多種文檔 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)單。

image

主要功能

  1. 支持 examples
  2. 支持 schema 校驗(yàn)
  3. 支持工具測(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

image.png

7. docway 接口文檔管理工具

網(wǎng)址:www.docway.net

image.png


其他工具

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

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末泄鹏,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子秧耗,更是在濱河造成了極大的恐慌备籽,老刑警劉巖,帶你破解...
    沈念sama閱讀 206,482評(píng)論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件分井,死亡現(xiàn)場(chǎng)離奇詭異车猬,居然都是意外死亡霉猛,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,377評(píng)論 2 382
  • 文/潘曉璐 我一進(jìn)店門(mén)珠闰,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)惜浅,“玉大人,你說(shuō)我怎么就攤上這事伏嗜√诚ぃ” “怎么了?”我有些...
    開(kāi)封第一講書(shū)人閱讀 152,762評(píng)論 0 342
  • 文/不壞的土叔 我叫張陵阅仔,是天一觀的道長(zhǎng)吹散。 經(jīng)常有香客問(wèn)我,道長(zhǎng)八酒,這世上最難降的妖魔是什么空民? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 55,273評(píng)論 1 279
  • 正文 為了忘掉前任,我火速辦了婚禮羞迷,結(jié)果婚禮上界轩,老公的妹妹穿的比我還像新娘。我一直安慰自己衔瓮,他們只是感情好浊猾,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,289評(píng)論 5 373
  • 文/花漫 我一把揭開(kāi)白布。 她就那樣靜靜地躺著热鞍,像睡著了一般葫慎。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上薇宠,一...
    開(kāi)封第一講書(shū)人閱讀 49,046評(píng)論 1 285
  • 那天偷办,我揣著相機(jī)與錄音,去河邊找鬼澄港。 笑死椒涯,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的回梧。 我是一名探鬼主播废岂,決...
    沈念sama閱讀 38,351評(píng)論 3 400
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼狱意!你這毒婦竟也來(lái)了湖苞?” 一聲冷哼從身側(cè)響起,我...
    開(kāi)封第一講書(shū)人閱讀 36,988評(píng)論 0 259
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤髓涯,失蹤者是張志新(化名)和其女友劉穎袒啼,沒(méi)想到半個(gè)月后,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 43,476評(píng)論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡蚓再,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 35,948評(píng)論 2 324
  • 正文 我和宋清朗相戀三年滑肉,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片摘仅。...
    茶點(diǎn)故事閱讀 38,064評(píng)論 1 333
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡靶庙,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出娃属,到底是詐尸還是另有隱情六荒,我是刑警寧澤,帶...
    沈念sama閱讀 33,712評(píng)論 4 323
  • 正文 年R本政府宣布矾端,位于F島的核電站掏击,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏秩铆。R本人自食惡果不足惜砚亭,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,261評(píng)論 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望殴玛。 院中可真熱鬧捅膘,春花似錦、人聲如沸滚粟。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 30,264評(píng)論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)凡壤。三九已至署尤,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間亚侠,已是汗流浹背沐寺。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 31,486評(píng)論 1 262
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留盖奈,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 45,511評(píng)論 2 354
  • 正文 我出身青樓狐援,卻偏偏與公主長(zhǎng)得像钢坦,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子啥酱,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,802評(píng)論 2 345

推薦閱讀更多精彩內(nèi)容