README.md · 道心/swaggerLUI

# SwaggerLUI
***SwaggerLUI*** 是一款开源的接口调试、文档管理工具，基于swagger扩展，使用spring boot+layui技术；仅支持swagger注解的接口项目。

--------

**前言**
- swagger本身的ui界面用起来不习惯；
- 有些接口调试支持的不是很好，如上传、下载；
- 有些开发文档管理起来太麻烦，比较零散，希望跟接口一起维护；
- 接口调试功能和文档维护在一起，前后端分离模式下体验好些；
- 基于以上原因忍不住造了一个轮子，共享出来，有需要的可以试试；

**特点**
- 自定义接口访问地址，可以不依赖到项目中；
- 也可以方便依赖到项目中，打包为一个jar；
- 方便的接口调试功能，支持多种复杂参数；
- 良好的接口文档界面，可以查看复杂入参、出参，使前后端分离模式更友好；
- 支持post上传、下载调试，更多模式持续更新；
- 可以维护自定义的md文档到这个接口调试工具中；

**目的**
- 接口方便调试；
- 前后端分离下，有统一的文档管理和查看；
- 希望开发过程中更规范化；

**项目演示地址**
- [http://49.233.23.145:7777/swagger_lui_index.html](http://49.233.23.145:7777/swagger_lui_index.html)

- [antd 版:http://49.233.23.145:8088/dx_antw_doc.html](http://49.233.23.145:8088/dx_antw_doc.html)

- 演示地址是给大家看的，不要使劲搞，没做什么安全防范，也别加入乱七八糟的文件，加了马上删掉，谢谢。
- 注意，首次进入时，必须设置 接口访问地址:http://49.233.23.145:7777/

#### 软件架构
spring boot+layui

#### 安装教程

- 下载 swaggerLUI，打包为jar
- 在需要的项目中依赖打包好的jar

```bash
   <dependency>
   	<groupId>com.swagger.lui</groupId>
   	<artifactId>swaggerLUI</artifactId>
   	<version>0.0.1-SNAPSHOT</version>
   </dependency>
```

- 在你自己的项目中配置数据源信息，一般是application.properties文件

```bash
   使用h2数据库
   swlui.driver=org.h2.Driver
   h2数据库地址：d:/h2/swluidbtest  地址和数据库名称设置为自己的
   swlui.url=jdbc:h2:d:/h2/swluidbtest
   h2数据库的用户名随便设置的
   swlui.username=root
   h2数据库的密码随便设置的
   swlui.password=123456
```
- 在启动类中需如下配置
添加扫描包：com.swagger.lui

```java
@ComponentScan(basePackages = { "com.swagger.lui" })
```
- 在WebMvcConfig中添加如下代码

```java
 @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("swagger_lui_index.html").addResourceLocations("classpath:/swagger/doc/");
        registry.addResourceHandler("/**").addResourceLocations("classpath:/swagger/lui/");
        super.addResourceHandlers(registry);
    }
```
- 运行
http://ip+端口+/swagger_lui_index.html
如：http://localhost:8088/swagger_lui_index.html

- 界面
不截图了，请到demo项目上查看

#### 使用说明

- 系统参数设置
首次使用需要运行【系统初始化】，删除表和数据库,并重新创建,注意，此操作会删掉自定义文档信息，无法还原
- 全局参数设置
调试过程中可以设置一些经常用到的参数，方便调试
- MD文档管理
管理自定义MD文档，可以为自己的项目编写开发规范、注意事项等，方便查看、交流、维护；

#### DEMO工程使用
1. 下载swaggerLUIDEMO-0.0.1-SNAPSHOT.jar
2. 启动 java -jar swaggerLUIDEMO-0.0.1-SNAPSHOT.jar --server.port=7777
3. 运行http://localhost:7777/swagger_lui_index.html
4. 首次运行可能会报错，不用理会，是没初始化数据库的原因
5. 设置接口访问地址：http://localhost:7777/
6. 运行【系统初始化按钮】，然后可以到【MD文档管理中操作】

#### 参与贡献

1. ...

#### License

The apache 2.0 licence

道心/swaggerLUI

简介

发行版

贡献者

近期动态

道心/swaggerLUI .gitee-modal { width: 500px !important; }

简介

发行版

开源评估指数源自 OSS-Compass 评估体系，评估体系围绕以下三个维度对项目展开评估：

贡献者

近期动态

搜索帮助

道心/swaggerLUI