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

 更新时间:2018年01月31日 14:30:28   作者:萧明  
这篇文章主要介绍了在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的方法,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对脚本之家网站的支持!

相关文章

  • SpringBoot实现微服务通信的多种方式

    SpringBoot实现微服务通信的多种方式

    微服务通信是指在分布式系统中,各个微服务之间进行数据交互和通信的过程,今天我们将探讨在Spring Boot中实现微服务通信的多种方式,文章通过代码示例给大家介绍的非常详细,需要的朋友可以参考下
    2024-07-07
  • 简单了解Mybatis如何实现SQL防注入

    简单了解Mybatis如何实现SQL防注入

    这篇文章主要介绍了简单了解Mybatis如何实现SQL防注入,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-01-01
  • Java任务定时执行器案例的实现

    Java任务定时执行器案例的实现

    定时器会执行指定的任务,本文主要介绍了Java任务定时执行器案例的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2022-06-06
  • 简单了解Spring中的事务控制

    简单了解Spring中的事务控制

    这篇文章主要介绍了简单了解Spring中的事务控制,事务是一组操作的执行单元,下面我们来简单学习一下吧
    2019-05-05
  • JAVA验证码工具实例代码

    JAVA验证码工具实例代码

    这篇文章主要介绍了JAVA验证码工具实例代码,需要的朋友可以参考下
    2018-03-03
  • Java如何根据根据IP地址获取省市

    Java如何根据根据IP地址获取省市

    这篇文章主要为大家详细介绍了两种在Java中获取IP地址对应地理位置信息的方法,分别是使用ip2region库和GeoIP库,感兴趣的小伙伴可以了解下
    2025-01-01
  • SpringBoot+Eureka实现微服务负载均衡的示例代码

    SpringBoot+Eureka实现微服务负载均衡的示例代码

    这篇文章主要介绍了SpringBoot+Eureka实现微服务负载均衡的示例代码,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-11-11
  • Java中的自旋锁解析

    Java中的自旋锁解析

    这篇文章主要介绍了Java中的自旋锁解析,自旋锁是指当一个线程尝试获取某个锁时,如果该锁已被其他线程占用,就一直循环检测锁是否被释放,而不是进入线程挂起或睡眠状态,需要的朋友可以参考下
    2023-10-10
  • SpringSecurity OAtu2+JWT实现微服务版本的单点登录的示例

    SpringSecurity OAtu2+JWT实现微服务版本的单点登录的示例

    本文主要介绍了SpringSecurity OAtu2+JWT实现微服务版本的单点登录的示例,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-05-05
  • J2SE基础之在Eclipse中运行hello world

    J2SE基础之在Eclipse中运行hello world

    本文的内容非常的简单,跟随世界潮流,第一个Java程序输出“Hell World!”。希望大家能够喜欢
    2016-05-05

最新评论