ShowDoc，APIDoc，可道雲API-適合IT企業的文檔工具

一、ShowDoc官方文檔及說明

ShowDoc就是一個非常適合IT團隊的在線文檔分享工具，它可以加快團隊之間溝通的效率。
ShowDoc：點擊查看官方文檔及說明手冊

1.1 它可以用來做什麼

• API文檔（ 查看Demo）
  隨着移動互聯網的發展，BaaS（後端即服務）越來越流行。服務端提供API，APP端或者網頁前端便可方便調用數據。用ShowDoc可以非常方便快速地編寫出美觀的API文檔。
• 數據字典（ 查看Demo）
  一份好的數據字典可以很方便地向別人說明你的數據庫結構，如各個字段的釋義等。
• 說明文檔 （ 查看Demo）
  你完全可以使用showdoc來編寫一些工具的說明書,也可以編寫一些技術規範說明文檔以供團隊查閱。

1.2 它都有些什麼功能

• 分享與導出
  響應式網頁設計，可將項目文檔分享到電腦或移動設備查看。同時也可以將項目導出成word文件，以便離線瀏覽。
• 權限管理
  • 公開項目與私密項目
    ShowDoc上的項目有公開項目和私密項目兩種。公開項目可供任何登錄與非登錄的用戶訪問，而私密項目則需要輸入密碼驗證訪問。密碼由項目創建者設置。
  • 項目轉讓
    項目創建者可以自由地把項目轉讓給網站的其他用戶。
  • 項目成員
    你可以很方便地爲ShowDoc的項目添加、刪除項目成員。項目成員可以對項目進行編輯，但不可轉讓或刪除項目（只有項目創建者纔有權限）
  • 團隊管理
    利用showdoc的團隊功能你可以更好地進行團隊協作。
• 編輯功能
  • markdown編輯
    ShowDoc採用markdown編輯器，無論是編輯還是閱讀體驗都極佳很棒。如果你不瞭解Markdown，請在搜索引擎搜索”認識與入門 Markdown”
  • 模板插入
    在ShowDoc的編輯頁面，點擊編輯器上方的按鈕可方便地插入API接口模板和數據字典模板。插入模板後，剩下的就是改動數據了，省去了很多編輯的力氣。
  • 歷史版本
    ShowDoc爲頁面提供歷史版本功能，你可以方便地把頁面恢復到之前的版本。
• 多平臺
  showdoc支持網頁版、手機app版和電腦客戶端版。客戶端地址可見：https://www.showdoc.cc/clients

1.3 使用在線的ShowDoc

• 如果你沒有自己的服務器，但又想使用ShowDoc作爲分檔分享工具，你可以使用在線的ShowDoc http://www.showdoc.cc
• 在線showdoc作爲在線服務會長期維護，請放心託管數據

1.4 Docker方式安裝

# 原版官方鏡像安裝命令(中國大陸用戶不建議直接使用原版鏡像，可以用後面的加速鏡像)
docker pull star7th/showdoc 
# 中國大陸鏡像安裝命令（安裝後記得執行docker tag命令以進行重命名）
docker pull registry.cn-shenzhen.aliyuncs.com/star7th/showdoc
docker tag registry.cn-shenzhen.aliyuncs.com/star7th/showdoc:latest star7th/showdoc:latest 
##後續命令無論使用官方鏡像還是加速鏡像都需要執行
#新建存放showdoc數據的目錄
mkdir /showdoc_data
mkdir /showdoc_data/html
chmod  -R 777 /showdoc_data
#啓動showdoc容器
docker run -d --name showdoc -p 4999:80 -v /showdoc_data/html:/var/www/html/ star7th/showdoc

二、APIDoc 詳解 api接口文檔生成

相關內容原文地址：
CSDN：Dom_留聲機：apiDoc 詳解 api接口文檔生成

2.1 安裝apidoc

npm install apidoc -g

2.2 配置(apidoc.json)

每次導出接口文檔都必須要讓apidoc讀取到apidoc.json文件(如果未添加配置文件，導出報錯)，你可以在你項目的根目錄下添加apidoc.json文件，這個文件主要包含一些項目的描述信息，比如標題、簡短的描述、版本等，你也可以加入一些可選的配置項，比如頁眉、頁腳、模板等。
apidoc.json

{
  "name": "系統接口文檔",
  "version": "0.0.1",
  "description": "文檔總描述",
  "title": "apidoc瀏覽器自定義標題",
  "url" : "文檔url地址"
}

如果你的項目中使用了package.json文件(例如:node.js工程)，那麼你可以將apidoc.json文件中的所有配置信息放到package.json文件中的apidoc參數中：
package.json

{
 "name": "系統接口文檔",
  "version": "0.0.1",
  "description": "文檔總描述",
  "apidoc": {
    "title": "apidoc瀏覽器自定義標題",
 	 "url" : "文檔url地址"
  }
}

三、可道雲API

可道雲API官網：http://kodcloud.com/
點擊前往可道雲API官網