showdoc(api文檔工具)

showdoc(api文（wén）檔工具)對於it行業的（de）工作者來說（shuō）相當實用，通過它能夠更加快捷的編寫出精美api技（jì）術文檔，使用方（fāng）法簡單，而且軟件內自帶多種模板，包括api接口模板、數據字典模板（bǎn）等等（děng），新手（shǒu）如果不熟練的話可以先使用模（mó）板來練手。

showdoc電腦版（bǎn）介紹：

showdoc就是一個非常適合IT團隊的在線文檔分享工具，它（tā）可以加快團隊（duì）之間溝通的效率，通過showdoc，你可以方便地使（shǐ）用markdown語法來書寫出美觀的API文檔、數據字典文檔、技術（shù）文檔、在線excel文（wén）檔（dàng）等等（děng）。

showdoc怎麽用？

首先編寫API接口的人員（yuán）需要注冊（cè）一（yī）個賬號，便於不同（tóng）設備（bèi）的同步管理。

登錄成功後，首先展示的是各項目（mù）列表，如果未創建（jiàn）過項目，官方也給出了基本實例。

實例文檔如下，左側是目錄（支持多級目（mù）錄），右側主區域為左側所選的接口實際內容（róng），默認展示第一條。

一個基礎的接口示例，接口文檔使用（yòng）人員需要的時候，隻需要將地址欄鏈接複（fù）製（zhì）即可，不登錄的情況下是無（wú）法做修（xiū）改的。

軟件功能：

分享與導出

響應式網頁設計（jì），可將項目文檔分享（xiǎng）到電腦或移（yí）動（dòng）設備查看。同時也可以將（jiāng）項目導出成（chéng）word文（wén）件，以便離線瀏覽。

markdown編輯

ShowDoc采用markdown編輯器，無論是編輯還是閱讀體驗都極佳很棒。如果你不了解Markdown，請（qǐng）在搜索引擎搜索”認識與入門（mén） Markdown”。

曆史版本

ShowDoc為頁麵提供曆史版本功能，你可以方便地把（bǎ）頁麵恢複到（dào）之前的版本。

模板插（chā）入

在ShowDoc的編輯頁麵，點擊編輯器上方的按鈕（niǔ）可方便（biàn）地插入API接口模板（bǎn）和數據字典模板。插入（rù）模板後，剩下的就是改動數據了，省去了（le）很多編輯的力氣。

權限（xiàn）管理：

公開項目與私密項目

ShowDoc上的項目有（yǒu）公開項目和私密項目兩（liǎng）種。公開項目可供任（rèn）何登錄與非登錄的用戶訪（fǎng）問，而私密項目（mù）則需要輸入密碼驗證訪問。密碼由項目創建者（zhě）設置。

項目轉（zhuǎn）讓

項目創建者可以自（zì）由地把項目轉讓給網站的其他（tā）用戶。

團隊（duì）管理

你可以自行添（tiān）加多個團隊，為團隊分配（pèi）不同的（de）項目（mù），同時設置團隊裏每個人的權限。

項目成員

你可以很方便地為ShowDoc的項（xiàng）目添加（jiā）、刪除項目成員。項目成員可以（yǐ）對項（xiàng）目進行編輯，但不可（kě）轉讓或刪除項目（隻有項目創建者才有權限）

常見問題：

錯誤提示（shì）”General error: 11 database disk image is malformed”？

請確保服務器安裝好了php環境和php-sqlite擴展；如果你以FTP方式上傳代碼（mǎ）到服務器，那麽請使用二進製（zhì）模式上傳，否則會損害數據庫文（wén）件，導致此錯誤提示。

驗證碼（mǎ）不顯示？

請檢（jiǎn）查是否安裝了php-gd庫。

提示驗證碼驗證失（shī）敗？

先（xiān）到php.ini文件下找找session的保存目錄，然後檢查安裝session目錄有（yǒu）沒（méi）有寫入權限，或（huò）者可不可能是磁盤空間（jiān）滿了的問題。

怎麽進入管理後台？

新安裝完（wán）成（chéng）後，默認管理員賬號是showdoc/123456 。使用管理員帳戶登錄後，在項目列表頁麵的右上角（jiǎo）便能看到管理後（hòu）台入口。如果不能，請重新登錄或者刷新瀏覽（lǎn）器緩存（cún）試試。

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

runapi需要外網（wǎng）網絡（luò）。如果在確保已經（jīng）有了外（wài）網網絡，可以這樣嚐試：首先卸載runapi，然後刪除以下路徑C:\Users\Administrator\AppData\Roaming\runapi（其中Administrator可替換為你（nǐ）當前登（dēng）錄（lù）win係統的賬戶名），然後再重（chóng）裝runapi。MAC環境的用戶可以考慮使用AppCleaner來卸載（zǎi）和清理（lǐ）數據後再重（chóng）裝（zhuāng）。

RunApi客戶端看不（bú）到showdoc的項目？

runapi的數據可以生成markdown格式，但不可逆，markdown數據很難再轉換回來runapi。所以它無法跟showdoc原有（yǒu）數據互相轉換。隻是它們可以共用文檔瀏覽/團隊協作等（děng）功能。同時runapi生成的文檔隻能在runapi上編輯（jí），不能在showdoc上（shàng）編輯。後（hòu）麵如果要做數據共（gòng）用，可能需要對showdoc編寫格式有一定（dìng）的（de）規範約束，這個後麵再探索（suǒ）下。