node.js项目中,使用apidoc生成接口文档,同一个apiGroup下的多个接口,到页面上只展示一个接口,这是为什么,改为不同的group名字,就可以展示,接口注解如下所示:
'use strict'
/**
* @api {POST} /user create a user
* @apiDescription 用户新增的接口
* @apiName 用户注册
* @apiGroup User
* @apiSuccessExample Success-Response:
* {
* errorCode: 0,
* status: 200,
* data: {
* _id: '123',
* name: 'morehao',
* createdAt: '20180913',
* updatedAt: '20180913',
* lastLogin: '暂未登录'
* }
* }
* @apiErrorExample {json} Error-Response:
* {
* status: 200,
* errorCode: 20100,
* errorMsg: '该用户已经存在'
* }
*/
/**
* @api {DELETE} /user/:_id delete a user
* @apiDescription 用户删除的接口
* @apiName 删除用户
* @apiGroup User
* @apiParam {String} _id 用户的id
* @apiSuccessExample Success-Response:
* {
* errorCode: 0,
* status: 200,
* data: "用户删除成功!"
* }
* @apiErrorExample {json} Error-Response:
* {
* status: 200,
* errorCode: 20100,
* errorMsg: '该用户已经存在'
* }
*/
生成的接口文档页面截图:
写法仔细看了很多遍,感觉没有问题,很纳闷,难道是我没发现?
附上项目地址,项目地址如下:
项目地址
刚刚解决,@apiName使用英文就好了,这种问题,真让人难受啊。。。。。