swagger-admin

本项目已停止维护，作者推荐您使用功能更丰富的企业版本：Torna

一个Swagger文档管理后台，可统一管理多个项目的Swagger文档，只需要一个Java8环境，下载后即可运行使用

• 支持导入json，非Java项目也可以使用
• 支持swagger3
• 支持Basic认证
• 支持文档搜索，方便过滤文档
• 支持树形表格展示复杂参数
• 支持接口调试，支持文件上传、下载

使用步骤

• 前往发行版页面，下载最新版本zip文件
• 解压zip，如果是Mac/Linux操作系统，运行startup.sh文件启动，Windows操作系统运行cmd输入java -jar swagger-admin.jar启动
• 浏览器访问http://localhost:6970/
• 添加项目，确保项目已启动并且配置了Swagger

默认端口是6970，更改端口号按如下方式：

• Mac/Linux操作系统：打开startup.sh文件，修改--server.port参数值
• Windows操作系统：可执行：java -jar swagger-admin.jar --server.port=端口号

docker运行

• 方式一：下载公共镜像

docker pull tanghc2020/swagger-admin:latest

下载完毕后，执行docker run --name swagger-admin -p 6970:6970 -d <镜像ID>

浏览器访问http://ip:6970/

• 方式二：本地构建镜像

clone代码，然后执行docker-build.sh脚本

执行docker run --name swagger-admin -p 6970:6970 -d <镜像ID>

工程说明

• front：前端vue
• admin：后端服务
• db：数据库初始化文件
• script：辅助脚本

用到的技术：SpringBoot + Mybatis + Vue

自主构建

构建环境：Maven3+，Java8+，npm

• 自动构建[推荐]：

Mac/Linux系统可直接执行build.sh进行构建，构建结果在dist文件夹下。

• 手动构建：

  cd front

  • 执行npm run build:prod进行打包，结果在dist下
  • 把dist中的所有文件，放到admin/src/main/resources/public下

  cd ..

  • 执行mvn clean package，在gen/target下会生成一个swagger-admin-xx-SNAPSHOT.jar（xx表示本号）
  • 执行java -jar swagger-admin-xx-SNAPSHOT.jar
  • 浏览器访问http://localhost:6970/

效果图

沟通交流

Q群：167643071