適合寫api接口文檔的管理工具有哪些?

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

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

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

image
image

1.Showdoc:

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

image

網(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ā)效率帖渠!

image
image

主要功能

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

image

[](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)目公開狀態(tài),私有項(xiàng)目需要通過(guò)Token訪問(wèn)何暇。
  6. 站點(diǎn)配置陶夜,二次開發(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é)作工具艰管,極致的文檔編寫體驗(yàn)滓侍,加快開發(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 文件格式編寫卜高,強(qiáng)大的官方支持醉冤,官方提供 atom 插件秩霍,支持語(yǔ)法智能提示及校驗(yàn),編寫快速簡(jiǎn)單蚁阳。

image

主要功能

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

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末既们,一起剝皮案震驚了整個(gè)濱河市濒析,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌啥纸,老刑警劉巖号杏,帶你破解...
    沈念sama閱讀 217,185評(píng)論 6 503
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異斯棒,居然都是意外死亡盾致,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,652評(píng)論 3 393
  • 文/潘曉璐 我一進(jìn)店門荣暮,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)庭惜,“玉大人,你說(shuō)我怎么就攤上這事渠驼◎诳椋” “怎么了?”我有些...
    開封第一講書人閱讀 163,524評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵迷扇,是天一觀的道長(zhǎng)百揭。 經(jīng)常有香客問(wèn)我,道長(zhǎng)蜓席,這世上最難降的妖魔是什么器一? 我笑而不...
    開封第一講書人閱讀 58,339評(píng)論 1 293
  • 正文 為了忘掉前任,我火速辦了婚禮厨内,結(jié)果婚禮上祈秕,老公的妹妹穿的比我還像新娘渺贤。我一直安慰自己,他們只是感情好请毛,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,387評(píng)論 6 391
  • 文/花漫 我一把揭開白布志鞍。 她就那樣靜靜地躺著,像睡著了一般方仿。 火紅的嫁衣襯著肌膚如雪固棚。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,287評(píng)論 1 301
  • 那天仙蚜,我揣著相機(jī)與錄音此洲,去河邊找鬼。 笑死委粉,一個(gè)胖子當(dāng)著我的面吹牛呜师,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播贾节,決...
    沈念sama閱讀 40,130評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼汁汗,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了氮双?” 一聲冷哼從身側(cè)響起碰酝,我...
    開封第一講書人閱讀 38,985評(píng)論 0 275
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎戴差,沒(méi)想到半個(gè)月后送爸,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,420評(píng)論 1 313
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡暖释,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,617評(píng)論 3 334
  • 正文 我和宋清朗相戀三年袭厂,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片球匕。...
    茶點(diǎn)故事閱讀 39,779評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡纹磺,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出亮曹,到底是詐尸還是另有隱情橄杨,我是刑警寧澤,帶...
    沈念sama閱讀 35,477評(píng)論 5 345
  • 正文 年R本政府宣布照卦,位于F島的核電站式矫,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏役耕。R本人自食惡果不足惜采转,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,088評(píng)論 3 328
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望瞬痘。 院中可真熱鬧故慈,春花似錦板熊、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,716評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至克婶,卻和暖如春筒严,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背情萤。 一陣腳步聲響...
    開封第一講書人閱讀 32,857評(píng)論 1 269
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留摹恨,地道東北人筋岛。 一個(gè)月前我還...
    沈念sama閱讀 47,876評(píng)論 2 370
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像晒哄,于是被迫代替她去往敵國(guó)和親睁宰。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,700評(píng)論 2 354

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