springboot集成swagger-bootstrap-ui

逃离我推掉我的手 2021-11-10 10:18 434阅读 0赞

# 1、官网地址 #

swagger-bootstrap-ui官网：[https://doc.xiaominfo.com/][https_doc.xiaominfo.com]

# 2、导入pom依赖 #

<table> 
 <tbody> 
 <tr> 
 <td style="vertical-align:top;width:426.1pt;"> &lt;!--swagger-api 依赖开始--&gt; &lt;dependency&gt; &nbsp;&nbsp;&nbsp; &lt;groupId&gt;io.springfox&lt;/groupId&gt; &nbsp;&nbsp;&nbsp; &lt;artifactId&gt;springfox-swagger2&lt;/artifactId&gt; &nbsp;&nbsp;&nbsp; &lt;version&gt;2.9.2&lt;/version&gt; &lt;/dependency&gt; &lt;dependency&gt; &nbsp;&nbsp;&nbsp; &lt;groupId&gt;com.github.xiaoymin&lt;/groupId&gt; &nbsp;&nbsp;&nbsp; &lt;artifactId&gt;swagger-bootstrap-ui&lt;/artifactId&gt; &nbsp;&nbsp;&nbsp; &lt;version&gt;1.9.2&lt;/version&gt; &lt;/dependency&gt; &lt;!--swagger-api 依赖结束--&gt; </td> 
 </tr> 
 </tbody> 
</table>

# 3、创建配置文件 #

项目中创建一个目录，创建配置文件

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4NTU1NDkw_size_16_color_FFFFFF_t_70][]

## 3.1、swaggerConfig ##

<table> 
 <tbody> 
 <tr> 
 <td style="vertical-align:top;width:426.1pt;"> package com.xiaomin.config; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.ComponentScan; import org.springframework.context.annotation.Configuration; import org.springframework.web.servlet.config.annotation.EnableWebMvc; import springfox.documentation.builders.ApiInfoBuilder; import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.service.ApiInfo; import springfox.documentation.service.Contact; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; @Configuration //必须存在 @EnableSwagger2 //必须存在 public class SwaggerConfig{ &nbsp;&nbsp; @Bean &nbsp;&nbsp;&nbsp; public Docket customDocket() { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()); &nbsp;&nbsp;&nbsp; } &nbsp; /*&nbsp; @Bean &nbsp;&nbsp;&nbsp; public Docket customDocket(){ &nbsp;&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;return new Docket(DocumentationType.SWAGGER_2) &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .apiInfo(apiInfo()) &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .groupName("学生管理") &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .select() &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .apis(RequestHandlerSelectors.basePackage("com.xiaomin.controller")) &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .paths(PathSelectors.any()) &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .build(); &nbsp;&nbsp;&nbsp; }*/ &nbsp;&nbsp;&nbsp; /** &nbsp;&nbsp;&nbsp;&nbsp; * name:开发者姓名 &nbsp;&nbsp;&nbsp;&nbsp; * url:开发者网址 &nbsp;&nbsp;&nbsp;&nbsp; * email:开发者邮箱 &nbsp;&nbsp;&nbsp;&nbsp; * @return &nbsp;&nbsp;&nbsp;&nbsp; */ &nbsp;&nbsp;&nbsp; private ApiInfo apiInfo() { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Contact contact = new Contact("张三", "http://www.zhangsan.xyz", "18088888888@163.com"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; return new ApiInfoBuilder() &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .title("张三测试API接口")//标题 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .description("API接口的描述")//文档接口的描述 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .contact(contact) &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .version("1.1.0")//版本号 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .build(); &nbsp;&nbsp;&nbsp; } } &nbsp; </td> 
 </tr> 
 </tbody> 
</table>

## 3.2、WebMvcConfig ##

# 4、访问 #

[http://localhost:8080/doc.html][http_localhost_8080_doc.html]

截图：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4NTU1NDkw_size_16_color_FFFFFF_t_70 1][]

[https_doc.xiaominfo.com]: https://doc.xiaominfo.com/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4NTU1NDkw_size_16_color_FFFFFF_t_70]: /images/20211109/cee8e99da05948f198a543b368471125.png
[http_localhost_8080_doc.html]: http://localhost:8080/doc.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4NTU1NDkw_size_16_color_FFFFFF_t_70 1]: /images/20211109/a035294630714d03ad820d4a66b6efa8.png