# swagger-admin

**Repository Path**: techutter/swagger-admin

## Basic Information

- **Project Name**: swagger-admin
- **Description**: 一个Swagger文档管理后台，可统一管理多个项目的Swagger文档
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 64
- **Created**: 2020-11-19
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# swagger-admin

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

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

> 企业版正在开发中...

## 使用步骤

- 前往[发行版页面](https://gitee.com/durcframework/swagger-admin/releases)，下载最新版本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/`

## 效果图

![预览图](https://images.gitee.com/uploads/images/2020/1003/121222_440d1206_332975.png "130_1.png")

![预览图](https://images.gitee.com/uploads/images/2020/1003/121234_7a1e4337_332975.png "130_2.png")

![预览图](https://images.gitee.com/uploads/images/2020/1003/121244_256f2a1f_332975.png "130_3.png")


## 沟通交流

Q群：167643071