SwaggerLUI 正在参加 2020 年度 OSC 中国开源项目评选,请投票支持!
SwaggerLUI 在 2020 年度 OSC 中国开源项目评选 中已获得 {{ projectVoteCount }} 票,请投票支持!
投票让它出道
已投票
授权协议: Apache
开发语言: Java
操作系统: 跨平台
收录时间: 2020-05-22
提 交 者: 易-极

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


前言

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

特点

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

目的

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

项目演示地址

软件架构

spring boot+layui

安装教程

  • 下载 swaggerLUI,打包为jar
  • 在需要的项目中依赖打包好的jar
   <dependency>
   	<groupId>com.swagger.lui</groupId>
   	<artifactId>swaggerLUI</artifactId>
   	<version>0.0.1-SNAPSHOT</version>
   </dependency>
  • 在你自己的项目中配置数据源信息,一般是application.properties文件
   使用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
@ComponentScan(basePackages = { "com.swagger.lui" })
  • 在WebMvcConfig中添加如下代码
 @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使用说明

  • 系统参数设置 首次使用需要运行【系统初始化】,删除表和数据库,并重新创建,注意,此操作会删掉自定义文档信息,无法还原
  • 全局参数设置 调试过程中可以设置一些经常用到的参数,方便调试
  • MD文档管理 管理自定义MD文档,可以为自己的项目编写开发规范、注意事项等,方便查看、交流、维护; ####DEMO工程使用
  • 下载swaggerLUIDEMO-0.0.1-SNAPSHOT.jar
  • 启动 java -jar swaggerLUIDEMO-0.0.1-SNAPSHOT.jar --server.port=7777
  • 运行http://localhost:7777/swagger_lui_index.html
  • 首次运行可能会报错,不用理会,是没初始化数据库的原因
  • 设置接口访问地址:http://localhost:7777/
  • 运行【系统初始化按钮】,然后可以到【MD文档管理中操作】
展开阅读全文

代码

的 Gitee 指数为
超过 的项目

SwaggerLUI 的相关资讯

还没有任何资讯

SwaggerLUI 的相关博客

还没有任何博客,写博客

SwaggerLUI 的相关问答

还没有任何问答,马上提问

评论 (0)

加载中
更多评论
0 评论
11 收藏
分享
返回顶部
顶部