• 设为首页
  • 点击收藏
  • 手机版
    手机扫一扫访问
    迪恩网络手机版
  • 关注官方公众号
    微信扫一扫关注
    公众号

swaggerLUI: SwaggerLUI 是一款开源的接口调试、文档管理工具,基于swagger扩展,使用 ...

原作者: [db:作者] 来自: 网络 收藏 邀请

SwaggerLUI

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);    }

使用说明

  • 系统参数设置首次使用需要运行【系统初始化】,删除表和数据库,并重新创建,注意,此操作会删掉自定义文档信息,无法还原
  • 全局参数设置调试过程中可以设置一些经常用到的参数,方便调试
  • 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

Copyright (c) 2020-2021 道心


鲜花

握手

雷人

路过

鸡蛋
该文章已有0人参与评论

请发表评论

全部评论

专题导读
上一篇:
teedoc: 静态网站/文档网站生成工具,快速使用 markdown 或者 jupyter notebook 编写 ...发布时间:2022-02-13
下一篇:
Kylin_Wiki: 发布时间:2022-02-13
热门推荐
热门话题
阅读排行榜

扫描微信二维码

查看手机版网站

随时了解更新最新资讯

139-2527-9053

在线客服(服务时间 9:00~18:00)

在线QQ客服
地址:深圳市南山区西丽大学城创智工业园
电邮:jeky_zhao#qq.com
移动电话:139-2527-9053

Powered by 互联科技 X3.4© 2001-2213 极客世界.|Sitemap