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

ShowDoc使用方法

安裝：

#下載腳本并賦予權限

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

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

./showdoc

其他命令：

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

#停止

./showdoc stop

#重啟

./showdoc restart

#升級showdoc到最新版

./showdoc update

#卸載showdoc

./showdoc uninstall

ShowDoc軟件用途

1、API文檔

隨著移動互聯網的發展，BaaS（后端即服務）越來越流行。服務端提供API，APP端或者網頁前端便可方便調用數據。用ShowDoc可以非常方便快速地編寫出美觀的API文檔，同時還將支持從代碼文件中自動生成API文檔

2、數據字典

一份好的數據字典可以很方便地向別人說明你的數據庫結構，如各個字段的釋義等。

3、說明文檔

你完全可以使用showdoc來編寫一些工具的說明書,也可以編寫一些技術規范說明文檔以供團隊查閱。
 

ShowDoc功能介紹

1、共享與導出來
響應式網站網頁制作，可將項目文檔分享到電腦上或移動設備查詢。另外還可以將項目導出來成word文檔，便于離線瀏覽。
2、編輯作用
（1）markdown編輯
ShowDoc選用markdown編輯器，不論是編輯還是閱讀文章感受都極好非常好。假如你沒掌握Markdown，請在百度搜索引擎檢索”了解與新手入門Markdown”
（2）模板插進
在ShowDoc的編輯網頁頁面，點一下編輯器上邊的按鍵可便捷地插進API插口模板和數據流圖模板。插進模板后，剩余的便是修改數據信息了，省掉了許多 編輯的氣力。
（3）歷史版本
ShowDoc為網頁頁面出示歷史版本作用，你可以便捷地把網頁頁面修復到以前的版本號。
3、管理權限
（1）公布項目與私秘項目
ShowDoc上的項目有公布項目和私秘項目二種。公布項目可供一切登陸和非登陸的客戶瀏覽，而私秘項目則必須輸入支付密碼認證瀏覽。登陸密碼由項目創建者設定。
（2）項目出讓
項目創建者能夠隨意地把項目出讓給網址的普通用戶。
（3）項目組員
你可以很便捷地為ShowDoc的項目加上、刪掉項目組員。項目組員能夠對項目開展編輯，但不能出讓或刪掉項目（僅有項目創建者才有管理權限）
（4）團隊協作
你可以填加好幾個精英團隊，為精英團隊分派不一樣的項目，另外設定精英團隊里每一個人的管理權限。