安装: 必须先安装node.js
安装完node.js, 打开命令行,执行 npm install apidoc -g
安装完成,在项目根目录添加apidoc.json
内容如下:
{
"name": "洗浴erp服务端",
"description": "洗浴ERP服务端 接口说明",
"title": "The title of this doc",
"version": "1.0.1",
"url": ""
}
添加注释:
""" 上传数据接口
@api {post} /upload/addbill 上传结账数据
@apiVersion 1.0.0
@apiGroup 数据上传
@apiName addbill
@apiDescription 上传结账数据,包含结账单、消费明细,支付明细,技师上钟信息
@apiParam {string} shopid 店铺标识
@apiParam {json} billinfo 结账单
@apiParam {json} billdetail 账单明细
@apiParam {json} paylist 支付明细
@apiParam {json} techlist 技师数据
@apiParamExample {json} 参数格式:
@apiError {int} code 0
@apiError {string} msg ""
@apiError {string} data "错误信息"
@apiErrorExample {json} 成功时的返回数据:
{
"code": 0,
"msg": "error",
"data": "错误信息"
}
"""
在cmd 执行命令:apidoc -i 项目目录/ -o 生成的文件目录/
说明:生成的文件目录,如果不存在,会自动创建.