ShowDoc(API文檔編輯工具)v2.4.0免費(fèi)版

ShowDoc是一款在線API文檔編寫工具，軟件采用markdown編輯器，用戶可以通過(guò)它快速編寫出美觀的API文檔，支持從代碼自動(dòng)生成API，可以進(jìn)行團(tuán)隊(duì)合作、任務(wù)分配，簡(jiǎn)單實(shí)用，功能齊全。

功能介紹

1、分享與導(dǎo)出

響應(yīng)式網(wǎng)頁(yè)設(shè)計(jì)，可將項(xiàng)目文檔分享到電腦或移動(dòng)設(shè)備查看。同時(shí)也可以將項(xiàng)目導(dǎo)出成word文件，以便離線瀏覽。

2、編輯功能

(1)markdown編輯

ShowDoc采用markdown編輯器，無(wú)論是編輯還是閱讀體驗(yàn)都極佳很棒。如果你不了解Markdown，請(qǐng)?jiān)谒阉饕嫠阉?rdquo;認(rèn)識(shí)與入門 Markdown”

(2)模板插入

在ShowDoc的編輯頁(yè)面，點(diǎn)擊編輯器上方的按鈕可方便地插入API接口模板和數(shù)據(jù)字典模板。插入模板后，剩下的就是改動(dòng)數(shù)據(jù)了，省去了很多編輯的力氣。

(3)歷史版本

ShowDoc為頁(yè)面提供歷史版本功能，你可以方便地把頁(yè)面恢復(fù)到之前的版本。

3、權(quán)限管理

(1)公開(kāi)項(xiàng)目與私密項(xiàng)目

ShowDoc上的項(xiàng)目有公開(kāi)項(xiàng)目和私密項(xiàng)目?jī)煞N。公開(kāi)項(xiàng)目可供任何登錄與非登錄的用戶訪問(wèn)，而私密項(xiàng)目則需要輸入密碼驗(yàn)證訪問(wèn)。密碼由項(xiàng)目創(chuàng)建者設(shè)置。

(2)項(xiàng)目轉(zhuǎn)讓

項(xiàng)目創(chuàng)建者可以自由地把項(xiàng)目轉(zhuǎn)讓給網(wǎng)站的其他用戶。

(3)項(xiàng)目成員

你可以很方便地為ShowDoc的項(xiàng)目添加、刪除項(xiàng)目成員。項(xiàng)目成員可以對(duì)項(xiàng)目進(jìn)行編輯，但不可轉(zhuǎn)讓或刪除項(xiàng)目(只有項(xiàng)目創(chuàng)建者才有權(quán)限)

(4)團(tuán)隊(duì)管理

你可以自行添加多個(gè)團(tuán)隊(duì)，為團(tuán)隊(duì)分配不同的項(xiàng)目，同時(shí)設(shè)置團(tuán)隊(duì)里每個(gè)人的權(quán)限。

軟件用途

1、API文檔

隨著移動(dòng)互聯(lián)網(wǎng)的發(fā)展，BaaS(后端即服務(wù))越來(lái)越流行。服務(wù)端提供API，APP端或者網(wǎng)頁(yè)前端便可方便調(diào)用數(shù)據(jù)。用ShowDoc可以非常方便快速地編寫出美觀的API文檔，同時(shí)還將支持從代碼文件中自動(dòng)生成API文檔

2、數(shù)據(jù)字典

一份好的數(shù)據(jù)字典可以很方便地向別人說(shuō)明你的數(shù)據(jù)庫(kù)結(jié)構(gòu)，如各個(gè)字段的釋義等。

3、說(shuō)明文檔

你完全可以使用showdoc來(lái)編寫一些工具的說(shuō)明書(shū),也可以編寫一些技術(shù)規(guī)范說(shuō)明文檔以供團(tuán)隊(duì)查閱。

使用方法

安裝：

#下載腳本并賦予權(quán)限

wget https://www.showdoc.cc/script/showdoc;chmod +x showdoc;

#默認(rèn)安裝中文版。如果想安裝英文版，請(qǐng)加上en參數(shù)，如 ./showdoc en

./showdoc

其他命令：

#執(zhí)行上面命令便會(huì)自動(dòng)安裝完成。下面附上腳本其他命令，以便管理showdoc時(shí)可以用得上。

#停止

./showdoc stop

#重啟

./showdoc restart

#升級(jí)showdoc到最新版

./showdoc update

#卸載showdoc

./showdoc uninstall