apidoc是一個輕量級的在線REST接口文檔生成系統，支持多種主流語言，包括Java、C、C#、PHP和Javascript等。使用者按照要求書寫相關注釋，就可以生成可讀性好、界面美觀的在線接口文檔。
【安裝】
apidoc是基于nodeJs平臺，在安裝apidoc之前，需要先安裝nodeJs。
下面介紹一下Windows平臺下nodeJs的安裝。
【nodeJs安裝】
首先，去[node.js官網]上下載最新的安裝包，請下載自己對應系統的安裝包。
下載完畢后，按照一般的軟件安裝步驟安裝即可。
按照安裝步驟安裝完畢后，node環境也已經配置好了，現在來驗證一下node是否已正確安裝配置。
首先，打開Window Shell窗口。使用win+R快捷鍵打開運行窗口，在文本框中輸入cmd并回車打開Windows Shell。
然后，在控制臺輸入node命令進入node控制臺。
最后，運行一個Hello World程序。在node控制臺中輸入console.info("hello world");，如果輸出如下圖所示的結果，則表示node安裝配置成功。
除了node之外，npm（node package manager，node安裝包管理器）也是很重要的，可以通過它來便捷地下載和安裝node應用。在Windows Shell中輸入npm命令，如果出現如下圖所示的信息，則表示npm也正確安裝完畢。
【apidoc安裝】
apidoc可以利用npm來快速安裝。
1、進入Windows Shell，輸入npm install apidoc -g進行apidoc的安裝，等待一定時間（根據自身的網速）的下載和安裝之后，如果出現下圖所示的信息，則表示apidoc安裝成功。
2、在Windows Shell中輸入apidoc -v命令，如果出現如下圖所示的界面，則表示apidoc已安裝成功。
【使用apidoc】
一個典型的文件目錄結果如下圖所示。
其中：
apidoc.json：apidoc的項目級配置文件，它必須位于整個工程目錄頂層。
1000.php：用于演示的demo源文件，它可以位于整個工程目錄的頂層目錄及其子目錄下。apidoc會搜索整個工程目錄選擇所有可能的源文件。
apidoc.json包含的代碼如下：
包含的代碼如下：
下面通過這個demo來介紹如何生成文檔文件。
首先，在Windows Shell中進入apidoc工程目錄的上層目錄。例如筆者的apidoc的工程位于E:\workspaces\sublime\apidoc 路徑下。在這個目錄中創建名為src的工程目錄，將apidoc.json和1000.php文件置于src目錄下。
然后，在Windows Shell中輸入apidoc -i src/ -o apidoc/命令，如果出現如下圖所示的Done結果，則表明文檔已經生成，位于同級目錄的apidoc（與-o apidoc對應）目錄下。
最后，打開apidoc目錄，可以看到如下圖所示的靜態Web文件。雙擊index.html就可以在瀏覽器中打開生成在線接口文檔網站。
配置
apidoc.json文件是項目級的配置文件，接下來簡單地介紹一下其中常用的配置項。
name 工程名。如果該字段不存在，則apidoc會嘗試通過package.json（apidoc頂層配置文件）來生成
version 工程文檔的版本號。如果該字段不存在，則apidoc會嘗試通過package.json（apidoc頂層配置文件）來生成
description 工程詳細描述。如果該字段不存在，則apidoc會嘗試通過package.json（apidoc頂層配置文件）來生成
title 文檔標題，顯示在文檔界面的最上方
url 整個api url的前綴，接下來的所有接口url都會加上這個前綴
sampleUrl api示例的url前綴。如果設置了這個值，則界面中顯示請求表單，可以用于測試接口
title 文檔頭（header）的連接錨點名
filename 文檔頭所使用的文件
footer 文檔尾（footer）的連接錨點名
filename 文檔尾所使用的文件
order 接口的排列順序list，如果不指定，則由apidoc自行確定
一個比較完整的配置文件如下：
更多的配置項請參考apidoc官方文檔站點。
