apidoc在@apiGroup使用中文的方法

最新推荐文章于 2024-07-04 19:43:05 发布

青野月音

最新推荐文章于 2024-07-04 19:43:05 发布

阅读量5.7k

点赞数 2

分类专栏： api 文章标签： api

本文链接：https://blog.csdn.net/GlatChen/article/details/79959444

版权

本文介绍了如何在apidoc中使用中文进行@apiGroup标记。推荐方法一是直接修改apidoc核心模块的api_group.js文件，注释掉相关字符替换代码。另一种方法是使用@apiDefine预先定义变量，但需要注意group的唯一性，适用于多个类的场景。

摘要由CSDN通过智能技术生成

个人强烈推荐方法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",
     *