ShowDoc客戶(hù)端下載|ShowDoc(API文檔編輯器) v2.4.0官方版

ShowDoc是一款采用markdown編輯器的API文檔編輯器！用戶(hù)可以使用它來(lái)創(chuàng)作出精美的API文檔！它還支持從代碼自動(dòng)生成API，功能強(qiáng)大！可以讓團(tuán)隊(duì)分工合作、任務(wù)分配，簡(jiǎn)單實(shí)用。

ShowDoc功能介紹

1.共享導(dǎo)出。
響應(yīng)性網(wǎng)頁(yè)設(shè)計(jì)，可以將項(xiàng)目文檔共享給計(jì)算機(jī)或移動(dòng)設(shè)備進(jìn)行查看。同時(shí)，還可以將項(xiàng)目導(dǎo)出到word文件中進(jìn)行脫機(jī)瀏覽。
2.編輯功能。
(1)降價(jià)編輯。
ShowDoc使用markdown編輯器，編輯閱讀體驗(yàn)極佳。如果您不知道Markdown，請(qǐng)?jiān)谒阉饕嬷兴阉?ldquo;了解和開(kāi)始使用Markdown”
(2)模板插入。
在ShowDoc的編輯頁(yè)面，點(diǎn)擊編輯器上方的按鈕，可以方便地插入API接口模板和數(shù)據(jù)字典模板。插入模板后，剩下的就是修改數(shù)據(jù)了，省去了大量的編輯工作。
(3)版本歷史。
ShowDoc為頁(yè)面提供了版本歷史功能，因此您可以輕松地將頁(yè)面恢復(fù)到以前的版本。
3.權(quán)限管理。
(1)公共項(xiàng)目和私人項(xiàng)目。
ShowDoc上有兩種項(xiàng)目:公共項(xiàng)目和私有項(xiàng)目。任何已登錄和未登錄的用戶(hù)都可以訪(fǎng)問(wèn)公共項(xiàng)目，而私有項(xiàng)目需要密碼驗(yàn)證。密碼由項(xiàng)目創(chuàng)建者設(shè)置。
(2)項(xiàng)目轉(zhuǎn)讓。
項(xiàng)目創(chuàng)建者可以自由地將項(xiàng)目轉(zhuǎn)移給網(wǎng)站的其他用戶(hù)。
(3)項(xiàng)目成員。
您可以輕松地為ShowDoc項(xiàng)目添加和刪除項(xiàng)目成員。項(xiàng)目成員可以編輯項(xiàng)目，但不能轉(zhuǎn)移或刪除項(xiàng)目(只有項(xiàng)目創(chuàng)建者有權(quán)限)
(4)團(tuán)隊(duì)管理。
您可以自己添加多個(gè)團(tuán)隊(duì)，為團(tuán)隊(duì)分配不同的項(xiàng)目，并為團(tuán)隊(duì)中的每個(gè)人設(shè)置權(quán)限。

ShowDoc軟件用途

1.API文件。
隨著移動(dòng)互聯(lián)網(wǎng)的發(fā)展，BaaS(后端即服務(wù))越來(lái)越流行。服務(wù)方面提供API，APP方面和web前端容易調(diào)用數(shù)據(jù)。使用ShowDoc可以非常方便快捷地編寫(xiě)美麗的API文件，同時(shí)支持從代碼文件中自動(dòng)生成API文件。
2.數(shù)據(jù)字典。
一個(gè)好的數(shù)據(jù)字典可以很容易地向別人解釋你的數(shù)據(jù)庫(kù)結(jié)構(gòu)，如各個(gè)字段的解釋。
3.說(shuō)明文件。
可以使用showdoc制作工具說(shuō)明書(shū)，也可以制作技術(shù)規(guī)范說(shuō)明書(shū)供團(tuán)隊(duì)查閱。
 

ShowDoc使用方法

安裝：

#下載腳本并賦予權(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

更新日志

1、界面簡(jiǎn)潔友好

2、性能體驗(yàn)優(yōu)化提升

3、修復(fù)了已知bug