ShowDoc下載-API文檔編輯工具v2.4.0免費下載2018最新版

ShowDoc是一款非常強大的文檔編輯軟件，本作主要的用處就是為團隊提供更加方便的交流工具。還可以非常方便快速地編寫出美觀的 API 文檔。需要的快點下載試試吧。

ShowDoc是什麼

每當接手一個他人開發好的模塊或者項目，看著那些沒有寫註釋的代碼，我們都無比抓狂。文檔呢?！文檔呢?！Show me the doc ！！

程序員都很希望別人能寫技術文檔，而自己卻很不希望要寫文檔。因為寫文檔需要花大量的時間去處理格式排版，想著新建的word文檔放在哪個目錄等各種非技術細節。

word文檔零零散散地放在團隊不同人那裡，需要文檔的人基本靠吼，吼一聲然後上qq或者郵箱接收對方丟過來的文檔。這種溝通方式當然可以，隻是效率不高。

ShowDoc就是一個非常適合IT團隊的在線文檔分享工具，它可以加快團隊之間溝通的效率。

ShowDoc可以做什麼

API文檔（ 查看Demo）

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

數據字典（ 查看Demo）

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

說明文檔（查看Demo ）

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

ShowDoc功能：

分享與導出

響應式網頁設計，可將項目文檔分享到電腦或移動設備查看。同時也可以將項目導出成word文件，以便離線瀏覽。

權限管理

公開項目與私密項目

ShowDoc上的項目有公開項目和私密項目兩種。公開項目可供任何登錄與非登錄的用戶訪問，而私密項目則需要輸入密碼驗證訪問。密碼由項目創建者設置。

項目轉讓

項目創建者可以自由地把項目轉讓給網站的其他用戶。

項目成員

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

團隊管理

你可以自行添加多個團隊，為團隊分配不同的項目，同時設置團隊裡每個人的權限。

編輯功能

markdown編輯

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

模板插入

在ShowDoc的編輯頁面，點擊編輯器上方的按鈕可方便地插入API接口模板和數據字典模板。插入模板後，剩下的就是改動數據瞭，省去瞭很多編輯的力氣。

歷史版本

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

ShowDoc亮點：

1：支持markdown語法（所有的api接口寫作現在都支持這個吧，因為他現在太方便瞭）

2：支持多用戶協作，你可以在項目下面隨意添加多個用戶一起完成api文檔的寫作。

3：可以分享並導出項目，生成需要的文檔格式如doc，可以離線瀏覽

4：支持響應式，手機電腦同樣精彩

5：支持項目轉讓

6：支持模版插入

7：支持歷史版本，你可以把操作恢復到以前的版本。

8：showdoc完全開源

9：可以部署到自己的服務器

10：如果在線使用，可以設置自己的個性域名，也可以對文檔進行加密，瀏覽者需要密碼才能訪問

11：可以通過一個在線測試api的工具，直接生成markdown，你幾乎不用寫代碼就能過所有的參數自動生成

ShowDoc常見問題：

忘記瞭密碼怎麼辦?

如果是使用在線ShowDoc，忘記密碼的話可聯系xing7th@gmail.com，郵件中說明你的用戶名和旗下項目名字。

如果是自己部署的ShowDoc，可以先自行註冊一個密碼為123456的新用戶。然後進數據庫，把user表裡新用戶的password字段覆蓋原用戶。這樣便可以將密碼重置為123456。登錄後，可在個人設置處改密碼。關於如何連接數據庫，請看本頁面後續問題。

若是自行部署開源版ShowDoc，請確保自己安裝好瞭PHP運行環境

建議按照指示來安裝PHP環境。

由於系統、軟件版本等情況各不相同，所以如果你一直安裝PHP環境失敗，可以嘗試使用Docker方式部署

開源版showdoc如何連接數據庫

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

錯誤提示”Could not find driver “

請安裝php-pdo 和 pdo_sqlite 。

對於Windowns服務器，在php.ini裡面把”extension=php_sqlite.dll”和”extension=php_pdo_sqlite.dll”啟用以便開啟對SQlite的支持;

Linux服務器安裝php5.3以上版本時理論上默認是開啟瞭php-pdo和pdo_sqlite的。如果你安裝的PHP依然沒有，則可搜索網絡教程安裝之。

可以使用mysql數據庫嗎

官方已經不再支持mysql數據庫， 如你真的需要強制使用mysql，則可自行二次開發，但官方不提供支持，也請勿浪費時間問官方團隊。經過二次開發的版本有可能與官方以後的版本升級沖突導致升級失敗，請謹慎考慮

驗證碼不顯示

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

提示驗證碼驗證失敗

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

安裝在ubuntu下，一直提示register fail

嘗試執行apt-get install php5-sqlite 或者apt-get install php7-sqlite3 以安裝sqlite支持

可以關閉註冊嗎?

編輯文件 server/Application/Api/Controller/UserController.class.php，

在register()裡面，這個方法的開頭處加上兩行代碼：

$this->sendError(10101,’不開放註冊’);return ;

怎麼進入管理後臺

新安裝完成後，默認管理員賬號是showdoc/123456 。使用管理員帳戶登錄後，在項目列表頁面的右上角便能看到管理後臺入口。如果不能，請重新登錄或者刷新瀏覽器緩存試試

自動腳本和docker安裝的showdoc如何綁定域名

不需要對showdoc做操作，請安裝個nginx，配置端口映射到本機的4999端口。至於nginx如何綁定域名，可搜索下網絡。

ShowDoc更新：

2018年11月

增加快速復制分享鏈接的功能

為瞭加強多人多團隊情形下的項目協作，正式推出團隊管理功能

2018年10月

為瞭應對復雜項目內容的分類需求，showdoc在原來目錄支持的基礎上增加一層子目錄，支持到瞭三級目錄。用戶在新建目錄的時候選擇父層目錄為二級目錄即可。

2018年9月

官網showdoc.cc改寫瞭URL轉發規則，使分享出去的URL更友好。開源版不支持此功能。

新增一鍵安裝/升級腳本

2018年8月

可通過代碼註釋自動生成API文檔。詳情請點擊任一個具體項目的項目設置頁面-開放API

頁面查看的時候增加歷史版本的入口

增加對IE11和edge瀏覽器的兼容支持

登錄/註冊頁面，項目密碼頁面增加回車快捷鍵支持

修改個人設置頁面在某些瀏覽器下不能點擊返回的bug

修復編輯器在某些情況下預覽為空白的bug

修復粘貼上傳圖片時會重復上傳的問題

修復保存文檔的快捷鍵(ctrl+s或command+s)

2018年7月

開源版showdoc新增管理後臺功能，可以統一添加、刪除用戶，以及對全部項目的管理。

2018年4月

支持自動化生成數據字典文檔

修復一個sql註入安全漏洞

2018年3月

修復一個跳過驗證碼註冊的bug

修復bugs

2018年2月

使用vue + element框架重構瞭ShowDoc的前端頁面，優化UI風格

提高不同頁面之間切換速度

項目展示頁面，左側欄允許收縮

優化目錄的添加和管理

2017年11月

禁止上傳的文件名後綴為php

禁止空目錄名的生成

禁止刪除非空的父目錄

2017年10月

為瞭安全性，關閉編輯器對html代碼的預覽

2017年9月

項目展示頁的左側欄將采用固定佈局，不會隨著網頁下拉而滾動，方便多目錄瀏覽。

項目展示頁的新建按鈕調整到目錄上方，以方便點擊。

默認隱藏登錄頁面和項目密碼訪問頁的驗證碼，減少用戶輸入時間。隻有當輸錯密碼大於一定次數時才會要求輸入驗證碼。

禁用server 目錄緩存，以便在不同服務器之間遷移。遷移直接復制文件夾過去即可

導出word文件的時候可以指定目錄

對話框優化

2017年8月

修復編輯器在部分可觸屏屏幕下的bug

修復json格式化工具會把number類型轉為string的bug

2017年7月

編輯文檔時支持直接插入html代碼，並支持預覽

關閉頁面緩存，使修改模板、配置時能立馬生效

優化首頁展示方式

新增項目歸檔功能

項目主頁可以置頂常用項目

優化目錄編輯頁面

2017年6月

修復部分瀏覽器下“點擊可放大查看圖片”功能與瀏覽器插件不兼容的bug

2017年5月

圖片可以粘貼上傳

點擊可放大查看圖片

顯示頁面的最後編輯時間和編輯人

2017年4月

項目展示頁的左側欄優化：打開三級目錄的頁面時，父目錄也會展開

支持站內鏈接

2017年1月

重寫項目設置，讓交互更友好

新增開放API，可以通過API來批量更新文檔

2016年12月

www.showdoc.cc 啟用更安全的https

增加logo

增加robots.txt

2016年11月

增加Docker部署方式

創建單頁項目功能

復制項目功能

支持單頁面分享功能

2016年10月

支持生成TOC目錄、科學公式、流程圖和序列圖

2016年9月

用戶可以預覽頁面歷史版本與最新版本的差異

項目創建者可以添加隻讀成員

2016年8月

完善安裝腳本

禁用html緩存、完善頁面css樣式

完善安裝腳本

推出v1.0.0正式版，並支持Composer方式安裝

放棄對Mysql的支持，全面使用Sqlite數據庫

新增Json格式化工具

完善在線測試API的工具（RunApi）

2016年7月

優化首頁，改用全屏單頁插件

新增自定義模板功能，允許用戶將自己的頁面設置為模板

保存頁面前可以添加註釋。添加的頁面註釋會在頁面的版本歷史顯示，方便查看頁面修改記錄

單賬戶允許同時多處登錄（原來隻允許同一時間單機登錄）

2016年6月

在配置文件可設置上傳圖片到七牛

用戶可設置個性域名

在線ShowDoc域名由doc.star7th.com更改為www.showdoc.cc

增加瞭多語言的支持

2016年5月

新增自助安裝腳本

新增ShowDoc使用交流qq群（群號：564671853）

支持三級目錄

歷史頁面保存到數據庫的時候采用壓縮，以減少數據庫體積

默認使用sqlite數據庫

單個頁面的歷史版本最多保留20個版本，以減少數據庫體積

把示例項目和幫助文檔指向在線showdoc，以方便以後更新文檔是隻需要更新在線的即可。showdoc的每個副本也就沒必要新建默認項目瞭

修改URL模式為兼容模式，這樣即使不再寫apache或者nginx的重定向規則，showdoc也能正常訪問

2016年4月

微調詳情頁的字體樣式

修復首頁輪播動畫

增加瞭頁面標題與地址欄鏈接變化

優化數據庫結構：

增加頁面title顯示當前項目的名稱，同時打開多個項目時方便定位頁面

2016年3月

完善左側欄UI

增加對nginx下重定向規則說明

修復一個自動登錄的bug

2016年2月

優化瞭樣式

增加復制頁面的功能

web安全：增加SQL過濾防止註入

2016年1月

URL不區分大小寫

新增快捷鍵操作

2015年12月

增加對刪除頁面的權限細分控制

新增圖片上傳功能

增加文檔搜索功能

刪除頁面和目錄前增加確認按鈕以防誤操作

2015年11月

ShowDoc誕生並開源