egg项目使用swagger编辑api接口文档
下载swagger-ui
下载地址:swagger-ui github地址
可以直接download zip,下载到本地之后解压
配合egg项目使用
把解压好的swagger-ui目录下的dist目录中的文件都放到egg项目中/app/public/swagger
到这里下载一个json配置文件
点击file
点击转换json
然后把这个json文件下载之后放到egg项目中/app/public/swagger中
然后再打开swagger中的index.html
把红框部分的url改为刚刚放进来的json文件路径
配置egg静态文件目录,实现在线预览api文档
打开egg项目的配置文件 /app/config/config.default.js
再添加如下配置
启动项目,在浏览器输入地址 http://localhost:7001/public/swagger/index.html 就可以预览文档了
接口详细介绍以及返回格式