springboot2.0 + swagger配置

最新推荐文章于 2023-12-04 09:34:48 发布

南风北巷sun

最新推荐文章于 2023-12-04 09:34:48 发布

阅读量436

点赞数

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/project_sun/article/details/100009616

本文详细介绍了如何在SpringBoot项目中集成Swagger2和swagger-bootstrap-ui，包括配置pom依赖、Swagger配置类、静态资源过滤及注解使用，帮助开发者快速搭建API文档。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

一、配置过程

1、引入pom依赖

<dependency>
     <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger2</artifactId>
      <version>2.9.2</version>
</dependency>

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

2、配置swagger

@EnableSwagger2
@Configuration
public class Swagger2Configuration{
	@Bean
    	public Docket createRestApi() {
        		return new Docket(DocumentationType.SWAGGER_2)
                		.apiInfo(apiInfo())
                		.select()
                		.apis(RequestHandlerSelectors.withClassAnnotation(Api.class))//这是注意的代码
              		  //.apis(RequestHandlerSelectors.basePackage("com.skn.keelin")) 
              		  //.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
               		 .paths(PathSelectors.any())
              		  //.paths(PathSelectors.regex("/.*"))
               		 .build();
    }

	private ApiInfo apiInfo() {
       		 return new ApiInfoBuilder()
              		  .title("xxx接口文档")
              		  .description("xxx相关接口的文档")
                		 .termsOfServiceUrl("http://www.xxx.com")
                		.version("1.0")
                		.build();
    }
}

3、配置swagger静态文件过滤

不进行此步骤，会报404

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
  public void addResourceHandlers(ResourceHandlerRegistry registry) {
    // 解决 swagger-ui.html 404报错
    registry.addResourceHandler("/swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");
    // 解决 doc.html 404 报错
    registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");
    registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
  }
}