Springboot整合Swagger2

Springboot整合Swagger2

版本说明以maven引入为例

SpringBoot版本：2.7.6、Swagger2的版本：3.0.0

<!--swagger2 访问地址：http://localhost:8848/swagger-ui/ -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

Swagger2配置文件

Swagger2Config.java

package com.glacialerisa.core.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.*;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @author : Glacialerisa
 * @date : 2024/1/1 13:43
 * @desc : Swagger2Config
 */
@Configuration
@EnableSwagger2
public class Swagger2Config {
  @Bean
  public Docket createRestApi() {
    ApiInfo apiInfo =
          new ApiInfoBuilder()
                .title("Board Game API")
                .description("Swagger2 集成API文档")
                .version("1.0")
                .contact(new Contact("Glacialerisa", "测试URL", "测试Email"))
                .license("我的首页")
                .licenseUrl("测试URL")
                .build();
    return new Docket(DocumentationType.SWAGGER_2)
          .apiInfo(apiInfo)
          .select()
          .apis(RequestHandlerSelectors.any())
          .paths(PathSelectors.any())
          .build();
  }
}

knife4j引入

若使用了knife4j美化swagger2，需在拦截器进行放行资源

<!--knife4j美化swagger2 访问地址：http://localhost:8848/doc.html -->
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>2.0.9</version>
</dependency>

package com.glacialerisa.core.config;

/**
 * @author : Glacialerisa
 * @date : 2024/1/1 14:59
 * @desc : WebMvcConfig
 */
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
  /**
   * 配置静态资源访问路径
   */
  @Override
  public void addResourceHandlers(ResourceHandlerRegistry registry) {
    // 静态资源访问路径和存放路径配置
    registry.addResourceHandler("/static/**").addResourceLocations("classpath:/static/","classpath:/public/");
    // swagger访问配置
    registry.addResourceHandler("/**").addResourceLocations("classpath:/META-INF/resources/","classpath:/META-INF/resources/webjars/");
  }
}

常用的注解

@ApiModel 用于对实体类的描述
@ApiModelProperty 用于对实体类属性的描述
@Api 用于对Controller进行描述
@ApiOperation 用于对Controller下的方法进行描述

注意事项

1. Swagger2在3.0版本后访问的地址由 http://localhost:8848/swagger-ui.html 变成了 http://localhost:8848/swagger-ui/
2. Swagger2版本和SpringBoot版本最好有一定的匹配