大橙子网站建设,新征程启航
为企业提供网站建设、域名注册、服务器等服务
这期内容当中小编将会给大家带来有关swagger-bootstrap-ui怎么在Spring Boot中使用,文章内容丰富且以专业的角度为大家分析和叙述,阅读完这篇文章希望大家可以有所收获。
创新互联专注于尉犁企业网站建设,自适应网站建设,商城网站建设。尉犁网站建设公司,为尉犁等地区提供建站服务。全流程按需定制,专业设计,全程项目跟踪,创新互联专业和态度为您提供的服务
swagger-bootstrap-ui 是基于swagger接口api实现的一套UI,因swagger原生ui是上下结构的,在浏览接口时不是很清晰,所以, 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 PaginationbannerInfoQuery(){ Pagination pagination = service.bannerInfoQuery(); return pagination; } }
上述就是小编为大家分享的swagger-bootstrap-ui怎么在Spring Boot中使用了,如果刚好有类似的疑惑,不妨参照上述分析进行理解。如果想知道更多相关知识,欢迎关注创新互联行业资讯频道。