showdoc mac版是一款適用于蘋果電腦端的mac在線API文檔編輯軟件,軟件采用markdown編輯器，用戶可以通過它快速編寫出美觀的API文檔，不僅可以從代碼文件中自動生成API文檔，同時你可以自行添加多個團(tuán)隊, 滿足用戶的多種需求, 感興趣的朋友快來下載使用吧。

showdoc(API文檔編輯工具) 官方免費版

軟件功能

API文檔

APP、web前端與服務(wù)器常用API來進(jìn)行交互

用ShowDoc可以非常方便快速地編寫出美觀的API文檔

數(shù)據(jù)字典

好的數(shù)據(jù)字典可以很方便地向別人描述你的數(shù)據(jù)庫結(jié)構(gòu)

用ShowDoc可以編輯出美觀的數(shù)據(jù)字典

說明文檔

你完全可以使用 ShowDoc來編寫一些工具的說明書

也可以編寫一些技術(shù)規(guī)范說明文檔以供團(tuán)隊查閱

團(tuán)隊協(xié)作

團(tuán)隊權(quán)限管理機(jī)制讓團(tuán)隊良好地協(xié)同編寫文檔

免費開源

ShowDoc提供免費開源的版本

你可以選擇將ShowDoc部署到你的服務(wù)器

在線托管

www.showdoc.cc 提供安全穩(wěn)定的在線文檔托管服務(wù)

你可以放心地選擇托管你的文檔數(shù)據(jù)在云端

軟件用途

1、API文檔

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

2、數(shù)據(jù)字典

一份好的數(shù)據(jù)字典可以很方便地向別人說明你的數(shù)據(jù)庫結(jié)構(gòu)，如各個字段的釋義等。

3、說明文檔

你完全可以使用showdoc來編寫一些工具的說明書,也可以編寫一些技術(shù)規(guī)范說明文檔以供團(tuán)隊查閱。

常見問題：

忘記了密碼怎么辦？

如果是使用在線ShowDoc（http://www.showdoc.cc ），忘記密碼的話可聯(lián)系xing7th@gmail.com，郵件中說明你的用戶名和旗下項目名字。

如果是自己部署的ShowDoc，則首先根據(jù)前面安裝文檔進(jìn)行升級，確保使用最新代碼(劃重點）。然后，根據(jù)安裝方式的不同有不同的密碼重置方式。

如果是使用官方腳本或者docker方式安裝的，請在命令行執(zhí)行命令：

docker exec showdoc php /var/www/html/index.php home/common/repasswd

如果是手動安裝php方式的，則在命令行中切換到web目錄然后執(zhí)行：

php index.php home/common/repasswd

以上命令會把管理員showdoc的密碼重置為123456 。用此密碼登錄管理后臺即可管理普通用戶以及項目。建議登錄后修改密碼。

若修改密碼出錯，請確保自己采用最新版代碼。

若是自行部署開源版ShowDoc，請確保自己安裝好了docker或者PHP運(yùn)行環(huán)境

安裝PHP環(huán)境可以參考：http://www.showdoc.cc/php

由于系統(tǒng)、軟件版本等情況各不相同，所以如果你一直安裝PHP環(huán)境失敗，可以嘗試使用Docker方式部署：http://www.showdoc.cc/help?page_id=65610

如果你覺得手動安裝麻煩，或者覺得后期維護(hù)不方便，則可以使用在線ShowDoc http://www.showdoc.cc/

開源版showdoc如何連接數(shù)據(jù)庫

showdoc使用sqlite數(shù)據(jù)庫。數(shù)據(jù)庫文件是安裝目錄下的Sqlite/showdoc.db.php。你可以網(wǎng)絡(luò)搜索如何在命令行中使用 sqlite數(shù)據(jù)庫.或者使用SQLiteStudio等可視化工具

錯誤提示 “Could not find driver”

請安裝php-pdo 和 pdo_sqlite 。

對于Windowns服務(wù)器，在php.ini里面把”extension=php_sqlite.dll”和”extension=php_pdo_sqlite.dll”啟用以便開啟對SQlite的支持；

Linux服務(wù)器安裝php5.3以上版本時理論上默認(rèn)是開啟了php-pdo和pdo_sqlite的。如果你安裝的PHP依然沒有，則可搜索網(wǎng)絡(luò)教程安裝之。

錯誤提示”General error: 11 database disk image is malformed”

請確保服務(wù)器安裝好了php環(huán)境和php-sqlite擴(kuò)展；

如果你以FTP方式上傳代碼到服務(wù)器，那么請使用二進(jìn)制模式上傳，否則會損害數(shù)據(jù)庫文件，導(dǎo)致此錯誤提示

可以使用mysql數(shù)據(jù)庫嗎

官方已經(jīng)不再支持mysql數(shù)據(jù)庫，詳情可看：http://www.showdoc.cc/help?page_id=31990 如你真的需要強(qiáng)制使用mysql，則可自行二次開發(fā)，但官方不提供支持，也請勿浪費時間問官方團(tuán)隊。經(jīng)過二次開發(fā)的版本有可能與官方以后的版本升級沖突導(dǎo)致升級失敗，請謹(jǐn)慎考慮

驗證碼不顯示

請檢查是否安裝了php-gd庫