在Spring Boot中使用swagger-bootstrap-ui的方法

swagger-bootstrap-ui 是基于swagger接口api实现的一套UI,因swagger原生ui是上下结构的,在浏览接口时不是很清晰,所以, swagger-bootstrap-ui 是基于左右菜单风格的方式,适用与我们在开发后台系统左右结构这种风格类似,方便与接口浏览

GitHub: https://github.com/xiaoymin/Swagger-Bootstrap-UI

界面预览:

引入swagger

在pom.xml文件中引入swagger以及ui的jar包依赖

<dependency>
 <groupId>io.springfox</groupId>
 <artifactId>springfox-swagger2</artifactId>
 <version>2.7.0</version>
</dependency>
<!--引入ui包-->
<dependency>
 <groupId>com.github.xiaoymin</groupId>
 <artifactId>swagger-bootstrap-ui</artifactId>
 <version>1.7</version>
</dependency>

配置configuration

配置swagger的启用配置文件,关键注解 @EnableSwagger2

一下配置是支持接口分组的配置,如果没有分组配置,只需要创建一个 Docket 即可

@Configuration
@EnableSwagger2
public class SwaggerConfiguration {
​
 @Bean
 public Docket createRestApi() {
  return new Docket(DocumentationType.SWAGGER_2)
    .apiInfo(apiInfo())
    .groupName("资源管理")
    .select()
    .apis(RequestHandlerSelectors.basePackage("com.lishiots.dc.baseinfo.ctl"))
    .paths(PathSelectors.any())
    .build();
 }
 @Bean
 public Docket createMonitorRestApi() {
  return new Docket(DocumentationType.SWAGGER_2)
    .apiInfo(apiInfo())
    .groupName("实时监测")
    .select()
    .apis(RequestHandlerSelectors.basePackage("com.lishiots.dc.monitor.ctl"))
    .paths(PathSelectors.any())
    .build();
 }
 @Bean
 public Docket createActivitiRestApi() {
  return new Docket(DocumentationType.SWAGGER_2)
    .apiInfo(apiInfo())
    .groupName("工作流引擎")
    .select()
    .apis(RequestHandlerSelectors.basePackage("com.lishiots.dc.activiti.ctl"))
    .paths(PathSelectors.any())
    .build();
 }
​
 @Bean
 public Docket createBaseRestApi() {
  return new Docket(DocumentationType.SWAGGER_2)
    .apiInfo(apiInfo())
    .groupName("kernel模块")
    .select()
    .apis(RequestHandlerSelectors.basePackage("com.lishiots.dc.kernel.ctl"))
    .paths(PathSelectors.any())
    .build();
 }
​
 @Bean
 public Docket createComplaintRestApi() {
  return new Docket(DocumentationType.SWAGGER_2)
    .apiInfo(apiInfo())
    .groupName("投诉管理")
    .select()
    .apis(RequestHandlerSelectors.basePackage("com.lishiots.dc.complaint.ctl"))
    .paths(PathSelectors.any())
    .build();
 }
​
 private ApiInfo apiInfo() {
  return new ApiInfoBuilder()
    .title("swagger RESTful APIs")
    .description("swagger RESTful APIs")
    .termsOfServiceUrl("http://www.test.com/")
    .contact("xiaoymin@foxmail.com")
    .version("1.0")
    .build();
 }
}

Controller层使用swagger注解

ctl代码层:​

@Api(tags = "banner管理")
@RestController
@RequestMapping("/api/bannerInfo")
public class BannerCtl {
 @Autowired
 private BannerInfoService service;
 @PostMapping("/query")
 @ApiOperation(value = "查询banner",notes = "查询banner")
 public Pagination<BannerInfo> bannerInfoQuery(){
  Pagination<BannerInfo> pagination = service.bannerInfoQuery();
  return pagination;
 }
}

接口访问

在浏览器输入: http://${host}:${port}/doc.html

总结

以上所述是小编给大家介绍的在Spring Boot中使用swagger-bootstrap-ui的方法,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对我们网站的支持!

您可能感兴趣的文章:

  • Spring shiro + bootstrap + jquery.validate 实现登录、注册功能
  • spring MVC + bootstrap实现文件上传示例(带进度条)
  • Spring Boot+AngularJS+BootStrap实现进度条示例代码
  • 基于Bootstrap的Java开发问题汇总(Spring MVC)
  • 基于SpringMVC+Bootstrap+DataTables实现表格服务端分页、模糊查询
时间: 2018-01-30

基于SpringMVC+Bootstrap+DataTables实现表格服务端分页、模糊查询

前言 基于SpringMVC+Bootstrap+DataTables实现数据表格服务端分页.模糊查询(非DataTables Search),页面异步刷新. 说明:sp:message标签是使用了SpringMVC国际化 效果 DataTable表格 关键字查询 自定义关键字查询,非DataTable Search 代码 HTML代码 查询条件代码 <!-- 查询.添加.批量删除.导出.刷新 --> <div class="row-fluid"> <di

Spring shiro + bootstrap + jquery.validate 实现登录、注册功能

之前的文章中我们已经搭建好框架,并且设计好了,数据库. 现在我们开始实现登录功能,这个可以说是Web应用最最最普遍的功能了. 先来说说我们登录的逻辑: 输入用户名.密码(validate进行前端验证)--ajax调用后台action方法--根据用户名调用业务层到数据层查询数据库信息--查询的密码跟用户输入的密码比对--shiro登录身份验证--将用户信息存入session--响应前端--前端跳转 这个是我要告诉大家的姿势,还有很多很多的姿势.下面我们来看具体的代码. 首先前端验证,这里使用了jq

Spring Boot+AngularJS+BootStrap实现进度条示例代码

Spring Boot+AngularJS+BootStrap实现进度条 原理 进度条的原理是在上传文件的时候,当程序运行到某一个部分,往Session中设置一个1到100的值.然后前台再每隔很小的一段时间去请求这个值. 在AngularJS中,$http对象有3种状态,分别是success,progress,error,其中progress方法就会在success方法调用之前(也就是上传完成之前),不断地调用.而我们要做的就是在progress中在添加一个请求,去后台拿我们设置在session

spring MVC + bootstrap实现文件上传示例(带进度条)

最近学习了bootstrap,有结合了spring MVC写了个文件上传的示例,留做笔记,废话不多说,直接上代码 监听器类FileUploadProgressListener.Java package com.gpl.web.listener; import javax.servlet.http.HttpSession; import org.apache.commons.fileupload.ProgressListener; import org.springframework.stereo

基于Bootstrap的Java开发问题汇总(Spring MVC)

第一次接触Bootstrap框架,特别生疏.但是在慢慢了解了之后会发现bootstrap是一个前端的技术框架.结合了JQuery从而实现了非常丰富.美观的界面效果.此次项目是基于Spring MVC模式下. 1.菜单 在Bootstrap中构建一个菜单是一件非常容易的事情.因为有专门的菜单管理,所以相比以前做过的菜单相对来说就轻松的多.只需要点开菜单管理,进行需求菜单的添加.如下图所示: 添加完菜单之后还不能显示,因为没有为菜单分配权限.接下来在角色权限管理里面为菜单进行授权.之后用授权过的账户

JSP开发中在spring mvc项目中实现登录账号单浏览器登录

JSP开发中在spring mvc项目中实现登录账号单浏览器登录 在很多web产品中都需要实现在同一时刻,只能允许一个账号同时只能在一个浏览器当中登录.通俗点讲就是当A账号在 浏览器1当中登录了,此时在浏览器2中登录A账号.那么在浏览器1中的A账号将会被挤出去,当用户操作浏览器1的页面,页面会 跳到登录页面,需要重新登录.那么我们怎么实现这样的功能呢?下面将给大家进行详细的介绍: 原理 用户A使用账号a在浏览器当中登录,然后用户B在另外一台电脑上的浏览器登录账号a,当用户B登录验证成功时,将会触

Java中struts2和spring MVC的区别_动力节点Java学院整理

1.Struts2是类级别的拦截, 一个类对应一个request上下文,SpringMVC是方法级别的拦截,一个方法对应一个request上下文,而方法同时又跟一个url对应,所以说从架构本身上SpringMVC就容易实现restful url,而struts2的架构实现起来要费劲,因为Struts2中Action的一个方法可以对应一个url,而其类属性却被所有方法共享,这也就无法用注解或其他方式标识其所属方法了. 2.SpringMVC的方法之间基本上独立的,独享request respons

Bootstrap和Java分页实例第二篇

关于此文 运用第一篇分页的例子,结果以失败告终.在网上又寻找了很多例子.大多是都是这一种.着手开发的项目采用spring MVC框架.符合需求.摘下来,试了一试. 网上的例子总是少一些东西.经过一番折腾.终于搞定了.下面分享出来,供参考. 分页基本逻辑思想懂了,重点是在于怎么实现.怎么实现更好.还需要进一步思考. 配置xml-pager.tld <?xml version="1.0" encoding="UTF-8" ?> <taglib xmln

Spring MVC全局异常实例详解

目录 无SpringMVC全局异常时的流程图 SpringMVC全局异常流程图 其实是一个ModelAndView对象 配置文件 applicationcontext.xml <?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.

java开发中基于JDBC连接数据库实例总结

本文实例讲述了java开发中基于JDBC连接数据库的方法.分享给大家供大家参考,具体如下: 创建一个以JDBC连接数据库的程序,包含7个步骤: 1.加载JDBC驱动程序: 在连接数据库之前,首先要加载想要连接的数据库的驱动到JVM(Java虚拟机),这通过java.lang.Class类的静态方法forName(String  className)实现. 例如: try{ //加载MySql的驱动类 Class.forName("com.mysql.jdbc.Driver") ; }c

Java框架篇:Spring+SpringMVC+hibernate整合开发

前言: 最近没什么事做,搭个框架写成博客记录下来,拉通一下之前所学知识. 话不多说,我们直接步入正题. 准备工作: 1/安装并配置java运行环境 2/数据库的安装配置(Mysql) 3/安装并配置服务器(Tomcat) 4/Maven 5/ IntelliJIDEA的安装配置(本人使用的主要软件是IntelliJIDEA,没用eclipse什么的) 6/ 使用IntelliJIDEA创建一个web app项目. 貌似就这些了吧 导包 不同于以往的导包,由于我们创建的是maven的webapp项

Java中批处理框架spring batch详细介绍

spring batch简介 spring batch是spring提供的一个数据处理框架.企业域中的许多应用程序需要批量处理才能在关键任务环境中执行业务操作. 这些业务运营包括: 无需用户交互即可最有效地处理大量信息的自动化,复杂处理. 这些操作通常包括基于时间的事件(例如月末计算,通知或通信). 在非常大的数据集中重复处理复杂业务规则的定期应用(例如,保险利益确定或费率调整). 集成从内部和外部系统接收的信息,这些信息通常需要以事务方式格式化,验证和处理到记录系统中. 批处理用于每天为企业处

Spring MVC简介_动力节点Java学院整理

什么是Spring MVC Spring MVC属于SpringFrameWork的后续产品,已经融合在Spring Web Flow里面.Spring 框架提供了构建 Web 应用程序的全功能 MVC 模块.使用 Spring 可插入的 MVC 架构,从而在使用Spring进行WEB开发时,可以选择使用Spring的SpringMVC框架或集成其他MVC开发框架,如Struts1,Struts2等. 今天先从写一个Spring MVC的HelloWorld开始,让我们看看如何搭建起一个Spri

基于Spring MVC 简介及入门小例子(推荐)

一.什么是 Spring MVC Spring MVC 属于 SpringFrameWork 的后续产品,已经融合在 Spring Web Flow 里面,是一个强大灵活的 Web 框架.Spring MVC 提供了一个 DispatcherServlet 作为前端控制器来分配请求.通过策略接口,Spring 框架是高度可配置的.Spring MVC 还包含多种视图技术,如 Java Server Pages(JSP).Velocity.Tiles.iText 和 POI 等.Spring MV