欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

apidoc在@apiGroup使用中文的方法

程序员文章站 2022-04-03 07:57:58
...

个人强烈推荐方法1.

方法1.

C:\Users\Administrator\AppData\Roaming\npm\node_modules\apidoc\node_modules\apidoc-core\lib\workers\api_group.js,注释掉//group = group.replace(/[^\w]/g, '_');

注意:这里的“Administrator”只是我的电脑主机名,您的路径可能稍有不同。

预生成代码块:

    /**
     * @api {post} /api-security/get-token 获取TOKEN
     * @apiVersion 1.0.0
     * @apiName getToken
     * @apiGroup 安全校验类
     *
     * @apiParam {string} aes 来源
     * @apiParam {string} key 签名
     *
     * @apiSuccess {string} error 状态码1.成功、0.失败
     * @apiSuccess {string} code 错误码码10000.Successful、10005.非法请求、10007.参数错误、2001.验证码过期、2002.验证码错误,2003.尚未生成验证码
     * @apiSuccess {string} msg 返回详情
     * @apiSuccess {array[]} result 结果集
     *
     * @apiSuccessExample Success-Response:
     * HTTP/1.1 10000 OK
     * {
     *   "error":1,
     *   "code":"10000",
     *   "msg":"成功创建新TOKEN",
     *   "result":{
     *     "token":"2cea24050cfe8bc37f55fc03487cb9a5"
     *   }
     * }
     */

生成效果:

apidoc在@apiGroup使用中文的方法


方法2.

使用@apiDefine预先定义一个变量,例如定义@apiDefine group 方法类

预生成代码块:

    /**
     * @apiDefine group 安全校验类
     */

    /**
     * @api {post} /api-security/get-token 获取TOKEN
     * @apiVersion 1.0.0
     * @apiName getToken
     * @apiGroup group
     *
     * @apiParam {string} aes 来源
     * @apiParam {string} key 签名
     *
     * @apiSuccess {string} error 状态码1.成功、0.失败
     * @apiSuccess {string} code 错误码码10000.Successful、10005.非法请求、10007.参数错误、2001.验证码过期、2002.验证码错误,2003.尚未生成验证码
     * @apiSuccess {string} msg 返回详情
     * @apiSuccess {array[]} result 结果集
     *
     * @apiSuccessExample Success-Response:
     * HTTP/1.1 10000 OK
     * {
     *   "error":1,
     *   "code":"10000",
     *   "msg":"成功创建新TOKEN",
     *   "result":{
     *     "token":"2cea24050cfe8bc37f55fc03487cb9a5"
     *   }
     * }
     */
生成效果:

apidoc在@apiGroup使用中文的方法

生成的效果是一样的。

方法2有一个坑的地方,就是group具有唯一性。如果你有多个类最好这样做,

    /**
     * @apiDefine userGroup 用户类
     * @apiDefine orderGroup 订单类
     * @apiDefine securityGroup 安全校验类
     */

    /**
     * @api {post} /api-security/get-token 获取TOKEN
     * @apiVersion 1.0.0
     * @apiName getToken
     * @apiGroup securityGroup 
     */
如需转载,请注明出处:https://blog.csdn.net/GlatChen/article/details/79959444
相关标签: api