寫(xiě)在前面：你的代碼一定要用API注解，否則一頓操作猛如虎，導(dǎo)出就得犯迷糊，因?yàn)槟銓?dǎo)出了一個(gè)寂寞。
廢話不多說(shuō)，直接上操作步驟：
1、以windows系統(tǒng)為例，首先電腦上安裝node環(huán)境
1. node環(huán)境 #Node.js官網(wǎng) （下載最新的node.js msi安裝包即可，按提示安裝成功后，打開(kāi)cmd命令行）
node -v 回車(chē)
#出現(xiàn)版本號(hào)則說(shuō)明node安裝成功
2、如果安裝完nodejs沒(méi)有安裝上npm命令，請(qǐng)通過(guò)yum安裝npm
yum install npm
3、 安裝cnpm（淘寶鏡像）---可選項(xiàng)，也可不安裝
安裝完msi版本的node，已經(jīng)默認(rèn)安裝好npm工具。因?yàn)閲?guó)外官方npm太慢，故使用淘寶cnpm（這是一個(gè)完整 npm 鏡像，你可以用此代替官方版本(只讀)，同步頻率目前為 10分鐘 一次以保證盡量與官方服務(wù)同步。）
# 安裝cnpm淘寶鏡像
npm install -g cnpm --registry=https://registry.npm.taobao.org
# cnpm -v 回車(chē)（查看是否安裝成功）
4、安裝apidoc命令工具
cnpm install apidoc -g， 如果沒(méi)有安裝淘寶鏡像，則使用命令 npm install apidoc -g
當(dāng)然你也可以不全局安裝，只在需要導(dǎo)入apidoc文檔的目錄里安裝。
好了到這里，我們的環(huán)境安裝工作到此結(jié)束。
5、下面可以導(dǎo)出你代碼的api文檔了
apidoc -i 代碼所在目錄 -o apidoc文檔的輸出存儲(chǔ)目錄
6、導(dǎo)出的文檔結(jié)構(gòu)圖
一個(gè)靜態(tài)的文檔很漂亮的生成了，但是實(shí)際控制這個(gè)方法的是api_data.js和api_project.js。但是實(shí)際上的數(shù)據(jù)顯示是由api_data.json和api_project.json這兩個(gè) json 文件。
7、打開(kāi)Eolikner系統(tǒng)，選擇項(xiàng)目，在項(xiàng)目中導(dǎo)入apidoc
8、選擇api_data.json文件，點(diǎn)擊確認(rèn)等待導(dǎo)入即可。
至此就把本地代碼生成了apidoc文檔，又導(dǎo)入了Eolikner管理平臺(tái)上，就可以在平臺(tái)上進(jìn)行接口測(cè)試了。
寫(xiě)在后面：api模板的注解參數(shù)，供參考
@api {post} /v1/auth/register User Register *
@apiName UserRegister *
@apiGroup userAuthentication * *
@apiParam {String} username New user's username. *
@apiParam {String} password New user's password. * *
@apiSuccess {String} username The username of the register user. *
@apiSuccess {string} message The registering success info. * *
@apiSuccessExample Success-Response: * HTTP/1.1 200 OK * { * "username": "username", * "message": "User registered successful" * } * *
@apiError REGISTER_FAILURE The register failure. * *
@apiErrorExample Error-Response: * HTTP/1.1 500 Internal Server Error * { * "err": "REGISTER_FAILURE", * "message": "User register failure!" * }
