如何使用apidoc自动生成接口文档。

版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/GlatChen/article/details/79959684

1.首先,去node.js官网上下载最新的安装包,请下载自己对应系统的安装包,下载完毕后,按照一般的软件安装步骤安装即可。

2.win+R,输入cmd,打开命令行界面,

①.输入node,按回车,

②.再输入npm,再按回车,

③.最后输入npm install apidoc -g,按回车

④.等待一定时间(根据自身的网速)即可下载和安装成功。

3.进入这个路径,C:\Users\Administrator\AppData\Roaming\npm\node_modules\apidoc\node_modules\apidoc-core\lib\workers\api_group.js;

注释掉//group = group.replace(/[^\w]/g, '_')

(这个插件是老外搞出来的,虽然兼容了中文,但还有点小问题,就是在@apiGroup这里无法使用中文,坑的一批,步骤3就是解决这个坑的方法,一定不能忽略)。

4.在你的controller中书写备注,示范如下:

    /**
     * @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"
     *   }
     * }
     */

5.新建apidoc.json文件,文件内容如下:

{
  "name" : "API文档",
  "version": "1.0.0",
  "title": "呵呵哒-API文档",
  "description": "呵呵哒-API文档,仅限内部使用",
  "url" : "http://www.baidu.com"
}

我的目录结构如下:


我将这个apidoc.json文件放在client文件夹下。

6.生成命令是

apidoc -i 目录1 -o 目录2

现在我在client目录下,新建文件夹apidoc,输入

apidoc -i controllers/ -o apidoc/

就可以在client目录下生成一个apidoc文档,

可以将接口文档生成在其他目录下,只要输入正确的路径,示范如下:

apidoc -i controllers/ -o E:/apidoc/

7.生成文档。

这是生成的效果:


over.

这篇文章是极简版,apidoc其中玄妙不可道尽,感兴趣者可以查看官方文档.或者阅读下这篇博主的文章


如需转载,请注明出处:https://blog.csdn.net/GlatChen/article/details/79959684



阅读更多
想对作者说点什么?

博主推荐

换一批

没有更多推荐了,返回首页