SwaggerLUI 是一款开源的接口调试、文档管理工具,基于swagger扩展,使用sprigboot+layui技术;仅支持swagger注解的接口项目。
前言swagger本身的ui界面用起来不习惯;有些接口调试支持的不是很好,如上传、下载;有些开发文档管理起来太麻烦,比较零散,希望跟接口一期维护;接口调试功能和文档维护在一起,前后端分离模式下体验好些;基于以上原因忍不住造了一个轮子,共享出来,有需要的可以试试;特点自定义接口访问地址,可以不依赖到项目中;也可以方便依赖到项目中,打包为一个jar;方便的接口调试功能,支持多种复杂参数;良好的接口文档界面,可以查看复杂入参、出参,使前后端分离模式更友好;支持post上传、下载调试,更多模式持续更新;可以维护自定义的md文档到这个接口调试工具中;目的接口方便调试;前后端分离下,有统一的文档管理和查看;希望开发过程中更规范化;项目演示地址https://49.233.23.145:7777/swagger_lui_idex.html演示地址是给大家看的,不要使劲搞,没做什么安全防范,也别加入乱七八糟的文件,加了马上删掉,谢谢。软件架构sprigboot+layui安装教程下载swaggerLUI,打包为jar在需要的项目中依赖打包好的jar<depedecy><groupId>com.swagger.lui</groupId><artifactId>swaggerLUI</artifactId><versio>0.0.1-SNAPSHOT</versio></depedecy>在你自己的项目中配置数据源信息,一般是applicatio.properties文件使用h2数据库swlui.driver=org.h2.Driverh2数据库地址:d:/h2/swluidbtest地址和数据库名称设置为自己的swlui.url=jdbc:h2:d:/h2/swluidbtesth2数据库的用户名随便设置的swlui.userame=rooth2数据库的密码随便设置的swlui.password=123456在启动类中需如下配置添加扫描包:com.swagger.lui@CompoetSca(basePackages={"com.swagger.lui"})在WebMvcCofig中添加如下代码@OverridepublicvoidaddResourceHadlers(ResourceHadlerRegistryregistry){registry.addResourceHadler("swagger_lui_idex.html").addResourceLocatios("classpath:/swagger/doc/");registry.addResourceHadler("/**").addResourceLocatios("classpath:/swagger/lui/");super.addResourceHadlers(registry);}-运行 https://ip+端口+/swagger_lui_idex.html 如:https://localhost:8088/swagger_lui_idex.html使用说明系统参数设置首次使用需要运行【系统初始化】,删除表和数据库,并重新创建,注意,此操作会删掉自定义文档信息,无法还原全局参数设置调试过程中可以设置一些经常用到的参数,方便调试MD文档管理管理自定义MD文档,可以为自己的项目编写开发规范、注意事项等,方便查看、交流、维护;####DEMO工程使用下载swaggerLUIDEMO-0.0.1-SNAPSHOT.jar启动java-jarswaggerLUIDEMO-0.0.1-SNAPSHOT.jar--server.port=7777运行https://localhost:7777/swagger_lui_idex.html首次运行可能会报错,不用理会,是没初始化数据库的原因设置接口访问地址:https://localhost:7777/运行【系统初始化按钮】,然后可以到【MD文档管理中操作】点击空白处退出提示
评论