1 Star 0 Fork 55

springrain / swagger-admin

forked from tanghc / swagger-admin 
Create your Gitee Account
Explore and code with more than 6 million developers,Free private repositories !:)
Sign up
Clone or download
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
readme.md

swagger-admin

一个Swagger文档管理后台,可统一管理多个项目的Swagger文档

  • 使用简单,只需要一个Java8环境,下载后即可运行使用
  • 支持文档搜索,方便过滤文档
  • 支持树形表格展示复杂参数
  • 接口调试,支持文件上传、下载
  • 支持swagger3

用到的技术:SpringBoot + Mybatis + Vue

使用步骤

  • 前往发行版页面,下载最新版本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=端口号

工程说明

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

自主构建

需要安装Maven3,Java8

  • 自动构建[推荐]:

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/

效果图

预览图

预览图

Comments ( 0 )

Sign in for post a comment

About

一个Swagger文档管理后台,可统一管理多个项目的Swagger文档 spread retract
Java
MIT
Cancel

Releases

No release

Contributors

All

Activities

load more
can not load any more
Java
1
https://git.oschina.net/chunanyong/swagger-admin.git
git@git.oschina.net:chunanyong/swagger-admin.git
chunanyong
swagger-admin
swagger-admin
master

Search

103611 48b8ff67 1899542 103622 4d02230c 1899542