SpringBoot整合Swagger2使用

在SpringBoot中整合Swagger进行开发，首先需要引入依赖

引入依赖

<!--swagger依赖-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

swagger配置

package com.cxy.servicebase;
import com.google.common.base.Predicates;
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.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;
/**
 * @Title: SwaggerConfig
 * @Package com.cxy.servicebase
 * @Author: CXY
 * @Copyright CXY
 * @CreateTime: 2023/3/13 11:34
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket webApiConfig() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("webApi")
                .apiInfo(webApiInfo())
                .select()
                .paths(Predicates.not(PathSelectors.regex("/admin/.*")))
                .paths(Predicates.not(PathSelectors.regex("/error.*")))
                .build();
    }
    private ApiInfo webApiInfo() {
        return new ApiInfoBuilder()
                .title("网站-课程中心API文档")
                .description("本文档描述了课程中心微服务接口定义")
                .version("1.0")
                .contact(new Contact("Yeye", "http://cxy.com",
                        "55317332@qq.com"))
                .build();
    }
}

Swagger中@Api的description属性被废除

具体描述参考

SwaggerConfig中进行声明

//    声明tag
    public static  final String TAG_1="讲师管理";

在需要使用的类中进行引用tag

@Api(tags = {SwaggerConfig.TAG_1})

Swagger的常用属性

Swagger的常见属性可以参考下面的文章

SpringBoot版本过高整合Swagger时报错

报错信息如下

Failed to start bean ‘documentationPluginsBootstrapper’; nested exception is java.lang.NullPointerException

主要是因为版本冲突的问题，只需要在application.properties中添加配置信息如下即可解决：

#解决版本冲突问题
spring.mvc.pathmatch.matching-strategy=ANT_PATH_MATCHER