热门标签 | HotTags
当前位置:  开发笔记 > 前端 > 正文

在SpringBoot中使用swagger-bootstrap-ui的方法

这篇文章主要介绍了在SpringBoot中使用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包依赖


 io.springfox
 springfox-swagger2
 2.7.0



 com.github.xiaoymin
 swagger-bootstrap-ui
 1.7

配置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 bannerInfoQuery(){
  Pagination pagination = service.bannerInfoQuery();
  return pagination;
 }
}

接口访问

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

总结

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


推荐阅读
  • 基于KVM的SRIOV直通配置及性能测试
    SRIOV介绍、VF直通配置,以及包转发率性能测试小慢哥的原创文章,欢迎转载目录?1.SRIOV介绍?2.环境说明?3.开启SRIOV?4.生成VF?5.VF ... [详细]
  • 扫描线三巨头 hdu1928hdu 1255  hdu 1542 [POJ 1151]
    学习链接:http:blog.csdn.netlwt36articledetails48908031学习扫描线主要学习的是一种扫描的思想,后期可以求解很 ... [详细]
  • XNA 3.0 游戏编程:从 XML 文件加载数据
    本文介绍如何在 XNA 3.0 游戏项目中从 XML 文件加载数据。我们将探讨如何将 XML 数据序列化为二进制文件,并通过内容管道加载到游戏中。此外,还会涉及自定义类型读取器和写入器的实现。 ... [详细]
  • This document outlines the recommended naming conventions for HTML attributes in Fast Components, focusing on readability and consistency with existing standards. ... [详细]
  • 本文探讨了在通过 API 端点调用时,使用猫鼬(Mongoose)的 findOne 方法总是返回 null 的问题,并提供了详细的解决方案和建议。 ... [详细]
  • 探讨如何真正掌握Java EE,包括所需技能、工具和实践经验。资深软件教学总监李刚分享了对毕业生简历中常见问题的看法,并提供了详尽的标准。 ... [详细]
  • 精选15款免费扁平化界面设计资源
    高质量的网页和移动元素是任何Web或移动项目的基础。优秀的UI设计组件不仅能够提升用户体验,还能显著缩短设计师的工作时间,帮助他们快速创建出引人注目的作品。本文将分享一系列免费的扁平化设计素材。 ... [详细]
  • 本文介绍了一段使用jQuery实现的用户注册页面表单验证代码,适用于前端开发人员学习和参考。该示例结合了HTML、CSS和JavaScript,确保用户输入的数据格式正确。 ... [详细]
  • 本文详细介绍如何利用已搭建的LAMP(Linux、Apache、MySQL、PHP)环境,快速创建一个基于WordPress的内容管理系统(CMS)。WordPress是一款流行的开源博客平台,适用于个人或小型团队使用。 ... [详细]
  • 本文详细介绍了如何使用Python编写爬虫程序,从豆瓣电影Top250页面抓取电影信息。文章涵盖了从基础的网页请求到处理反爬虫机制,再到多页数据抓取的全过程,并提供了完整的代码示例。 ... [详细]
  • 本文介绍如何使用 Sortable.js 库实现元素的拖拽和位置交换功能。Sortable.js 是一个轻量级、无依赖的 JavaScript 库,支持拖拽排序、动画效果和多种插件扩展。通过简单的配置和事件处理,可以轻松实现复杂的功能。 ... [详细]
  • 探讨一个显示数字的故障计算器,它支持两种操作:将当前数字乘以2或减去1。本文将详细介绍如何用最少的操作次数将初始值X转换为目标值Y。 ... [详细]
  • Android LED 数字字体的应用与实现
    本文介绍了一种适用于 Android 应用的 LED 数字字体(digital font),并详细描述了其在 UI 设计中的应用场景及其实现方法。这种字体常用于视频、广告倒计时等场景,能够增强视觉效果。 ... [详细]
  • RecyclerView初步学习(一)
    RecyclerView初步学习(一)ReCyclerView提供了一种插件式的编程模式,除了提供ViewHolder缓存模式,还可以自定义动画,分割符,布局样式,相比于传统的ListVi ... [详细]
  • 本文详细介绍了如何在 Spring Boot 应用中通过 @PropertySource 注解读取非默认配置文件,包括配置文件的创建、映射类的设计以及确保 Spring 容器能够正确加载这些配置的方法。 ... [详细]
author-avatar
掩不住的心
这个家伙很懒,什么也没留下!
PHP1.CN | 中国最专业的PHP中文社区 | DevBox开发工具箱 | json解析格式化 |PHP资讯 | PHP教程 | 数据库技术 | 服务器技术 | 前端开发技术 | PHP框架 | 开发工具 | 在线工具
Copyright © 1998 - 2020 PHP1.CN. All Rights Reserved | 京公网安备 11010802041100号 | 京ICP备19059560号-4 | PHP1.CN 第一PHP社区 版权所有