温馨提示×

温馨提示×

您好,登录后才能下订单哦!

密码登录×
登录注册×
其他方式登录
点击 登录注册 即表示同意《亿速云用户服务条款》

swagger-bootstrap-ui怎么在Spring Boot中使用

发布时间:2021-03-29 16:56:30 来源:亿速云 阅读:169 作者:Leah 栏目:编程语言

这期内容当中小编将会给大家带来有关swagger-bootstrap-ui怎么在Spring Boot中使用,文章内容丰富且以专业的角度为大家分析和叙述,阅读完这篇文章希望大家可以有所收获。

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

界面预览:

swagger-bootstrap-ui怎么在Spring Boot中使用 

引入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;  } }

上述就是小编为大家分享的swagger-bootstrap-ui怎么在Spring Boot中使用了,如果刚好有类似的疑惑,不妨参照上述分析进行理解。如果想知道更多相关知识,欢迎关注亿速云行业资讯频道。

向AI问一下细节

免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。

AI