ApiDoc生成Resful接口文档

首先下载nodejs,官网下载
安装nodejs后,在安装目录新建node_cache和node_global文件夹。用于放缓存和全局安装的其他工具。

创建完两个空文件夹之后,打开cmd命令窗口,输入
npm config set prefix "D:\Develop\nodejs\node_global"
npm config set cache "D:\Develop\nodejs\node_cache"
设置环境变量:

1、 在【系统变量】下新建【NODE_PATH】,输入
       【D:\Develop\nodejs\node_global\node_modules】
2、将【用户变量】下的【Path】修改为【D:\Develop\nodejs\node_global】

安装npm淘宝镜像
因为npm安装有些工具时需要翻墙导致安装失败,安装淘宝镜像后使用cnpm方式安装
npm install -g cnpm --registry=https://registry.npm.taobao.org
安装apidoc
cnpm install apidoc -g
安装完成后 输入  apidoc -v 查看安装结果
apidoc使用

1、 在需要生成接口文档的目录下新建apidoc.json文件并配置如下:

{ 
  "name": "example", 
  "version": "0.1.0", 
  "description": "apiDoc basic example",
  "title": "Custom apiDoc browser title", 
  "url" : "https://api.github.com/v1"
}

2、严格遵守apidoc语法规范

比如:
  /**
     * @api {GET} /gordon/user/queryListOrByName 不分页查询所有或根据名称
     * @apiGroup 用户管理
     * 
     * @apiParam {String} name 用户姓名 (效果模糊匹配)
     * 
     * @apiErrorExample {json} 错误返回值: 
     *          { "code": "0", "message": "操作失败", }
     * @apiSuccessExample {json} 正确返回值:
     *           { "code": "1", "message": "操作成功", }
     */
其中像@apiErrorExample这类有返回示例的,示例一定要换行写

3、进入到有apidoc.json文件所在的目录,打开cmd ,如下直接在输入栏输入cmd然后回车就可以了

image.png

然后执行生成api文档命令:
image.png

image.png

参考:
      https://blog.csdn.net/xialei199023/article/details/63251482
     https://blog.csdn.net/soslinken/article/details/50468896

推荐阅读更多精彩内容