接口文档神器-apidoc使用方法

1、安装
npm install apidoc -g

2、在app目录下生成配置文件apidoc.json
{
“version”: “1.0.0”,
“description”: “xxx核心接口”,
“title”: “ggg系统接口”,
“url” : “http://test.com”,
“sampleUrl”: “http://test.com”
}

3、执行生成
apidoc -i src/ -o apidoc/
src-代码文件夹
apidoc-doc静态文件生成路径

注释格式举例:
“””
@api {POST} /api/user/getUserInfo
@apiName 取得用户信息 api
@apiGroup Group
@apiVersion 1.0.1
@apiDescription 取得用户信息
@apiPermission 登录用户
@apiSampleRequest http://api.test.com/api/user/getUserInfo
@apiParam {int} [id] any id
@apiParamExample {json} 请求例子:
{
“id”: 4711
}
@apiSuccess (200) {String} msg 信息
@apiSuccess (200) {int} code 200
@apiSuccess (200) {String} name 真实姓名
@apiSuccess (200) {String} mobile 手机号
@apiSuccess (200) {String} birthday 生日
@apiSuccess (200) {String} email 邮箱
@apiSuccessExample {json} 返回样例:
{
“code”: 200,
“msg”: “”,
“name”: “真实姓名”,
“mobile”: 12345678901,
“birthday”: “1980-03-05”,
“email”: “test@gamil.com”
}
@apiErrorExample {json} 错误返回:
{
“code”: 14695
“msg”: “数据出错”
}
“””

@apiParam {String} [paging=turn] 页式:slide-滑动(向上向下滚动效果时使用,手机端使用该参数值)turn-翻页模式,PC端使用
@apiParam {Integer} [index=0] 索引值 不同页式时的输入值:slide:最后一个条目的编号item_id turn:条目偏移量
@apiParam {Integer} [page_size=20] 每页显示条目数

发表评论

电子邮件地址不会被公开。 必填项已用*标注

*