今天kk下載為大家?guī)?lái)的著看名為“ShowDoc”是一款非常適用于團(tuán)隊(duì)使用的在線API文檔編寫工具。該軟件采用markdown編輯器，使用它能夠快速編寫出舒適的API文檔，并且ShowDoc支持從代碼自動(dòng)生成API，ShowDoc自動(dòng)生成api接口文檔，免去了寫完一個(gè)接口，還要去再寫一遍api文檔的煩惱。通過(guò)這款軟件能夠讓我們更好的進(jìn)行團(tuán)隊(duì)合作、任務(wù)分配等操作，有需要的用戶快來(lái)獲取他吧！

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

ShowDoc軟件用途

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ù)規(guī)范說(shuō)明文檔以供團(tuán)隊(duì)查閱。
 

ShowDoc功能介紹

1、共享與導(dǎo)出來(lái)
響應(yīng)式網(wǎng)站網(wǎng)頁(yè)制作，可將項(xiàng)目文檔分享到電腦上或移動(dòng)設(shè)備查詢。另外還可以將項(xiàng)目導(dǎo)出來(lái)成word文檔，便于離線瀏覽。
2、編輯作用
（1）markdown編輯
ShowDoc選用markdown編輯器，不論是編輯還是閱讀文章感受都極好非常好。假如你沒(méi)掌握Markdown，請(qǐng)?jiān)诎俣人阉饕鏅z索”了解與新手入門Markdown”
（2）模板插進(jìn)
在ShowDoc的編輯網(wǎng)頁(yè)頁(yè)面，點(diǎn)一下編輯器上邊的按鍵可便捷地插進(jìn)API插口模板和數(shù)據(jù)流圖模板。插進(jìn)模板后，剩余的便是修改數(shù)據(jù)信息了，省掉了許多 編輯的氣力。
（3）歷史版本
ShowDoc為網(wǎng)頁(yè)頁(yè)面出示歷史版本作用，你可以便捷地把網(wǎng)頁(yè)頁(yè)面修復(fù)到以前的版本號(hào)。
3、管理權(quán)限
（1）公布項(xiàng)目與私秘項(xiàng)目
ShowDoc上的項(xiàng)目有公布項(xiàng)目和私秘項(xiàng)目二種。公布項(xiàng)目可供一切登陸和非登陸的客戶瀏覽，而私秘項(xiàng)目則必須輸入支付密碼認(rèn)證瀏覽。登陸密碼由項(xiàng)目創(chuàng)建者設(shè)定。
（2）項(xiàng)目出讓
項(xiàng)目創(chuàng)建者能夠隨意地把項(xiàng)目出讓給網(wǎng)址的普通用戶。
（3）項(xiàng)目組員
你可以很便捷地為ShowDoc的項(xiàng)目加上、刪掉項(xiàng)目組員。項(xiàng)目組員能夠?qū)?xiàng)目開(kāi)展編輯，但不能出讓或刪掉項(xiàng)目（僅有項(xiàng)目創(chuàng)建者才有管理權(quán)限）
（4）團(tuán)隊(duì)協(xié)作
你可以填加好幾個(gè)精英團(tuán)隊(duì)，為精英團(tuán)隊(duì)分派不一樣的項(xiàng)目，另外設(shè)定精英團(tuán)隊(duì)里每一個(gè)人的管理權(quán)限。