寫在前面:你的代碼一定要用API注解,否則一頓操作猛如虎,導出就得犯迷糊,因為你導出了一個寂寞。
廢話不多說,直接上操作步驟:
1、以windows系統為例,首先電腦上安裝node環(huán)境
1. node環(huán)境 #Node.js官網 (下載最新的node.js msi安裝包即可,按提示安裝成功后,打開cmd命令行)
node -v 回車
#出現版本號則說明node安裝成功
2、如果安裝完nodejs沒有安裝上npm命令,請通過yum安裝npm
yum install npm
3、 安裝cnpm(淘寶鏡像)---可選項,也可不安裝
安裝完msi版本的node,已經默認安裝好npm工具。因為國外官方npm太慢,故使用淘寶cnpm(這是一個完整 npm 鏡像,你可以用此代替官方版本(只讀),同步頻率目前為 10分鐘 一次以保證盡量與官方服務同步。)
# 安裝cnpm淘寶鏡像
npm install -g cnpm --registry=https://registry.npm.taobao.org
# cnpm -v 回車(查看是否安裝成功)
4、安裝apidoc命令工具
cnpm install apidoc -g, 如果沒有安裝淘寶鏡像,則使用命令 npm install apidoc -g
當然你也可以不全局安裝,只在需要導入apidoc文檔的目錄里安裝。
好了到這里,我們的環(huán)境安裝工作到此結束。
5、下面可以導出你代碼的api文檔了
apidoc -i 代碼所在目錄 -o apidoc文檔的輸出存儲目錄
6、導出的文檔結構圖

一個靜態(tài)的文檔很漂亮的生成了,但是實際控制這個方法的是api_data.js和api_project.js。但是實際上的數據顯示是由api_data.json和api_project.json這兩個 json 文件。
7、打開Eolikner系統,選擇項目,在項目中導入apidoc

8、選擇api_data.json文件,點擊確認等待導入即可。
至此就把本地代碼生成了apidoc文檔,又導入了Eolikner管理平臺上,就可以在平臺上進行接口測試了。
寫在后面:api模板的注解參數,供參考
@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!" * }