showdoc(api文檔工具)對(duì)于it行業(yè)的工作者來說相當(dāng)實(shí)用，通過它能夠更加快捷的編寫出精美api技術(shù)文檔，使用方法簡(jiǎn)單，而且軟件內(nèi)自帶多種模板，包括api接口模板、數(shù)據(jù)字典模板等等，新手如果不熟練的話可以先使用模板來練手。

showdoc電腦版介紹：

showdoc就是一個(gè)非常適合IT團(tuán)隊(duì)的在線文檔分享工具，它可以加快團(tuán)隊(duì)之間溝通的效率，通過showdoc，你可以方便地使用markdown語法來書寫出美觀的API文檔、數(shù)據(jù)字典文檔、技術(shù)文檔、在線excel文檔等等。

showdoc怎么用？

首先編寫API接口的人員需要注冊(cè)一個(gè)賬號(hào)，便于不同設(shè)備的同步管理。

登錄成功后，首先展示的是各項(xiàng)目列表，如果未創(chuàng)建過項(xiàng)目，官方也給出了基本實(shí)例。

實(shí)例文檔如下，左側(cè)是目錄（支持多級(jí)目錄），右側(cè)主區(qū)域?yàn)樽髠?cè)所選的接口實(shí)際內(nèi)容，默認(rèn)展示第一條。

一個(gè)基礎(chǔ)的接口示例，接口文檔使用人員需要的時(shí)候，只需要將地址欄鏈接復(fù)制即可，不登錄的情況下是無法做修改的。

軟件功能：

分享與導(dǎo)出

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

markdown編輯

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

歷史版本

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

模板插入

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

權(quán)限管理：

公開項(xiàng)目與私密項(xiàng)目

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

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

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

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

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

項(xiàng)目成員

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

常見問題：

錯(cuò)誤提示”General error: 11 database disk image is malformed”？

請(qǐng)確保服務(wù)器安裝好了php環(huán)境和php-sqlite擴(kuò)展；如果你以FTP方式上傳代碼到服務(wù)器，那么請(qǐng)使用二進(jìn)制模式上傳，否則會(huì)損害數(shù)據(jù)庫(kù)文件，導(dǎo)致此錯(cuò)誤提示。

驗(yàn)證碼不顯示？

請(qǐng)檢查是否安裝了php-gd庫(kù)。

提示驗(yàn)證碼驗(yàn)證失??？

先到php.ini文件下找找session的保存目錄，然后檢查安裝session目錄有沒有寫入權(quán)限，或者可不可能是磁盤空間滿了的問題。

怎么進(jìn)入管理后臺(tái)？

新安裝完成后，默認(rèn)管理員賬號(hào)是showdoc/123456 。使用管理員帳戶登錄后，在項(xiàng)目列表頁(yè)面的右上角便能看到管理后臺(tái)入口。如果不能，請(qǐng)重新登錄或者刷新瀏覽器緩存試試。

RunApi客戶端打不開或者一直顯示加載中？

runapi需要外網(wǎng)網(wǎng)絡(luò)。如果在確保已經(jīng)有了外網(wǎng)網(wǎng)絡(luò)，可以這樣嘗試：首先卸載runapi，然后刪除以下路徑C:\Users\Administrator\AppData\Roaming\runapi（其中Administrator可替換為你當(dāng)前登錄win系統(tǒng)的賬戶名），然后再重裝runapi。MAC環(huán)境的用戶可以考慮使用AppCleaner來卸載和清理數(shù)據(jù)后再重裝。

RunApi客戶端看不到showdoc的項(xiàng)目？

runapi的數(shù)據(jù)可以生成markdown格式，但不可逆，markdown數(shù)據(jù)很難再轉(zhuǎn)換回來runapi。所以它無法跟showdoc原有數(shù)據(jù)互相轉(zhuǎn)換。只是它們可以共用文檔瀏覽/團(tuán)隊(duì)協(xié)作等功能。同時(shí)runapi生成的文檔只能在runapi上編輯，不能在showdoc上編輯。后面如果要做數(shù)據(jù)共用，可能需要對(duì)showdoc編寫格式有一定的規(guī)范約束，這個(gè)后面再探索下。