接口文档自动生成工具apidoc

Posted 2021-02-08 libinkai

　　前后端分离之后，接口文档是前后端沟通的必要手段。然后接口文档包含大量的重复性工作，费时费力，像apidoc这样工具就十分必要了。

　　官方文档：http://apidocjs.com/

　　--------------------------------------------------------------------------------------------------

　　首先说一下自己遇到的坑：

　　1、安装，node.js版本要高（在官网下最新的就行），不然后面有的模块会出问题，导致apidoc无法使用。

　　

　　2、生成接口文档之后，把文档放到服务器上面，发现接口文档无法加载

　　看一下浏览器的请求，发现是有些资源无法加载，但是文件确实是存在的

　　

　　后来发现是请求被nginx转发到tomcat里面了，修改一下nginx的配置文件即可，或者直接把文档放到tomcat目录下，通过其它端口（8080）访问。