官网
http://apidocjs.com/

 

安装
npm install apidoc -g

 

注：-i 应用目录 -o 输出apidoc位置 另命令要cd到应用根目录下运行

cd /data/apps/app_name

apidoc  -i  ./    -o    /data/doc/app_name/apidoc

/**
* @api {get} /index/Joker/getPointRules 1、获得无忧积分模板
* @apiGroup Joker
* @apiParam {String} token 登陆token
*
* @apiSuccess {Number} marker_add 一元超市消费增长多少积分
* @apiSuccess {Number} fee_add 一元网费充值增长多少积分
* @apiSuccess {float} market_sub 一积分抵扣多少超市消费
* @apiSuccess {float} fee_sub 一积分抵扣多少网费充值
*
* @apiSuccessExample {json} Success-Response:
* HTTP/1.1 200 OK
* {
* "code":0,
* "reason":"需求已经提交了，我们的工作人员会在2个工作日内和您取得联系!",
* "data":[]
* }
*/