apidoc在@apiGroup使用中文的方法

原创 2018年04月16日 13:48:21

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

生成效果:



方法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"
     *   }
     * }
     */
生成效果:


生成的效果是一样的。

方法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
版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/GlatChen/article/details/79959444

Web API文档生成工具apidoc

详情请看转载http://www.jianshu.com/p/bb5a4f5e588a window下安装http://www.bubuko.com/infodetail-948579.html...
  • qq_22074635
  • qq_22074635
  • 2016-04-27 17:42:02
  • 1450

使用apidocJs快速生成在线文档

apidoc是一个轻量级的在线REST接口文档生成系统,支持多种主流语言,包括Java、C、C#、PHP和Javascript等。使用者仅需要按照要求书写相关注释,就可以生成可读性好、界面美观的在线接...
  • xialei199023
  • xialei199023
  • 2017-03-18 10:40:00
  • 8454

apiDoc的使用

一、数组的扩展 1、Array.from( ) 转化为数组对象的方法,可以接受第二个参数,作为数组的map方法,对每个元素进行处理Array.from([1, , 2, , 3], (n) => ...
  • a464590569
  • a464590569
  • 2016-07-09 16:07:31
  • 578

使用apidoc 生成Restful web Api文档

在项目开发过程中,总会牵扯到接口文档的设计与编写,之前使用的都是office工具,写一个文档,总也是不够漂亮和直观。好在git上的开源大神提供了生成文档的工具,so来介绍一下! 该工具是Nodejs...
  • soslinken
  • soslinken
  • 2016-01-06 17:29:10
  • 35094

api文档生成器apidoc的安装和使用

在开发接口的过程中,需要向外发布相应的接口文档。开始的时候使用word来写文档,时间长了发现有几个问题。1. 编写不方便。每次新增借口的时候都要复制上一个接口,然后再进行修改,一些相同的部分无法复用...
  • qq_34627459
  • qq_34627459
  • 2017-05-13 14:42:36
  • 1108

Github开源项目之APIDOC

APIDOC的使用
  • fumier
  • fumier
  • 2016-01-20 10:22:09
  • 1465

apiDoc文档

完全转载自:http://www.cnblogs.com/wysiwyg/p/5969672.html apiDoc通过源代码里面的API注解生成一份文档 /** * @api ...
  • zhengwish
  • zhengwish
  • 2017-03-30 17:21:39
  • 1544

yiisoft/yii2-apidoc 扩展应用实践

来源: https://github.com/yiisoft/yii2-apidoc 用途:生成漂亮的API文档 This extension offers two commands: ap...
  • bennybi
  • bennybi
  • 2017-03-20 10:53:09
  • 354

apidoc的介绍和使用

apidoc是使用编写接口文档非常方便的,一种编写
  • lvbaolin123
  • lvbaolin123
  • 2016-09-26 16:50:47
  • 8698

apidoc的安装和使用

背景基于代码中注释部生成接口文档,apidoc安装1: 安装nodejs 下载最近版本: wget http://nodejs.org/dist/v7.2.0/node-v7.2.0.tar.gz...
  • ljp1919
  • ljp1919
  • 2016-11-28 16:51:11
  • 3388
收藏助手
不良信息举报
您举报文章:apidoc在@apiGroup使用中文的方法
举报原因:
原因补充:

(最多只允许输入30个字)