API開發文檔構建（ApiDoc）

1.下載Node.js

(註：高版本的JS自帶了NPM，所以我們不用另外去安裝NPM)

在cmd中查看是否安裝成功：

node -v

npm -v

2. 安裝apidoc

cnpm install apidoc -g

(用cnpm代替npm，即用國內鏡像而不是國外代理)

在CMD中查看是否安裝成功：

apidoc -v

3.構建文檔目錄：

搭建好的目錄架構如下：

apidoc---in

--apidoc.json(文檔架構)

--footer.md(文檔架構尾)

--header.md(文檔架構頭)

--myapp.java(介面信息編寫)

---out(空)

重點在於編寫apidoc.json和myapp.java兩個文件

4.使用方法

在E:workspaceapidocapidocin下：

編輯myapp.java文件

在cmd中鍵入以下命令（注意修改path）

apidoc -i E:workspaceapidocin -o E:workspaceapidocout

最後打開E:workspaceapidocout下的index.html即可

附：具體在項目中，由開發者將自己開發好的api更新，然後提交到公共盤或SVN上，保證每次都是最新的文檔，前端開發人員開發時只需在公共盤或SVN上查看即可，省時省力，便於管理。

參考鏈接：

搭建教程：http://www.bjhee.com/apidoc.html

錯誤處理：https://segmentfault.com/q/1010000005801746