18 Star 165 Fork 64

tanghc / swagger-admin

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

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

MIT License Copyright (c) 2020 tanghc Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

一个Swagger文档管理后台,可统一管理多个项目的Swagger文档 展开 收起
Java
MIT
取消

发行版 (15)

全部

贡献者

全部

近期动态

加载更多
不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
Java
1
https://gitee.com/durcframework/swagger-admin.git
git@gitee.com:durcframework/swagger-admin.git
durcframework
swagger-admin
swagger-admin
master

搜索帮助

344bd9b3 5694891 D2dac590 5694891