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

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

ShowDoc功能介紹

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

ShowDoc軟件用途

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

ShowDoc使用方法

安裝：

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

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

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

./showdoc

其他命令：

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

#停止

./showdoc stop

#重啟

./showdoc restart

#升級showdoc到最新版

./showdoc update

#卸載showdoc

./showdoc uninstall

更新日志

1、界面簡潔友好

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

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