使用Swagger生成Web API文档详细过程（SpringBoot、IDEA)

1、在pom.xml中添加依赖，注意添加到<dependencies></dependencies>标签中

<!--添加swagger2相关功能-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
<!--        添加swagger-ui相关功能-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

2、创建配置类SwaggerConfig

package com.example.helloword.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.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration//告诉Spring容器，这是一个配置类
@EnableSwagger2//启用Swagger2功能
public class SwaggerConfig {
/*
* 配种Swagger2相关的bean
* */
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com"))//com包下所有API都交给Swagger2管理
                .paths(PathSelectors.any()).build();
    }

    /*
    * 此处主要是API文档页面显示信息
    * */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("演示项目API")//标题
                .description("演示项目")//描述
                .version("1.0")//版本
                .build();
    }
}

注意：关于SpringBoot的配置类都需要加上注解@Configuration

3、Spring Boot 2.6.X后与Swagger有版本冲突问题，需要在application.properties中加入以下配置

spring.mvc.pathmatch.matching-strategy=ant_path_matcher

4、启动项目

5、打开浏览器地址栏，访问localhost:8080/swagger-ui.html

注意：此处8080端口为默认端口，若项目中有修改则按需改为自己设置的端口号