swagger-bootstrap-ui 是基于swagger接口api實(shí)現(xiàn)的一套UI,因swagger原生ui是上下結(jié)構(gòu)的，在瀏覽接口時不是很清晰,所以， swagger-bootstrap-ui 是基于左右菜單風(fēng)格的方式,適用與我們在開發(fā)后臺系統(tǒng)左右結(jié)構(gòu)這種風(fēng)格類似,方便與接口瀏覽
GitHub: https://github.com/xiaoymin/Swagger-Bootstrap-UI
界面預(yù)覽：
引入swagger
在pom.xml文件中引入swagger以及ui的jar包依賴
|
1
2
3
4
5
6
7
8
9
10
11
|
<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的啟用配置文件，關(guān)鍵注解 @EnableSwagger2
一下配置是支持接口分組的配置，如果沒有分組配置,只需要創(chuàng)建一個 Docket 即可
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
|
@Configuration@EnableSwagger2public 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("實(shí)時監(jiān)測") .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/") .version("1.0") .build(); }} |
Controller層使用swagger注解
ctl代碼層：?
|
1
2
3
4
5
6
7
8
9
10
11
12
13
|
@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
總結(jié)
以上所述是小編給大家介紹的在Spring Boot中使用swagger-bootstrap-ui的方法，希望對大家有所幫助，如果大家有任何疑問請給我留言，小編會及時回復(fù)大家的。在此也非常感謝大家對服務(wù)器之家網(wǎng)站的支持！
原文鏈接：http://blog.csdn.net/u010192145/article/details/79216037
