ApiDoc接口文档工具

最终的目录结构：
-project/
  |
  |__apidoc/
  |
  |__apidoc.json
  |
  |__app/
     |__controller/
        |__test.js

1 环境准备

npm install apidoc -g

2.版本查看

apidoc -v

如果出现以上报错，可以通过降低版本处理 ： npm install apidoc@0.28.1 -g

在项目的根目录下新建一个apidoc.json,进行如下配置

{
  "name": "测试api文档",
  "title": "测试api文档自动生成文档",
  "description":"测试api文档",
  "url" : "http://127.0.0.1:8080/api/",
  "forceLanguage":"zh-cn",
  "version": "1.0.0"
}

生成apidoc文件

apidoc -i api相对路径 -o apidoc/

例如：apidoc -i app/controller/ -o apidoc/

这时，apidoc文件夹下面就会生成相应的文件，直接访问其中的index.html,即可访问接口文档。

每次修改api的注释时，需要重新执行一下生成apidoc文件的命令。

具体的参数说明可以查阅官网 https://apidocjs.com/