Springboot 集成swagger

注意Spring boot 和swagger 的版本匹配问题

springboot2.3.2对应的swagger的版本是3.0.0

引入依赖：

<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-boot-starter</artifactId>
			<version>${swagger.version}</version>
		</dependency>

如果是swagger2，那么引入是：

<dependency>
				<groupId>io.springfox</groupId>
				<artifactId>springfox-swagger2</artifactId>
				<version>${swagger.version}</version>
</dependency>
<dependency>
				<groupId>io.springfox</groupId>
				<artifactId>springfox-swagger-ui</artifactId>
				<version>${swagger.version}</version>
</dependency>

一定要注意不同版本的swagger的使用方式

package com.chinasofti.huateng.ecds.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.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
/**
 * @Author test
 * @Date 2022/9/8 17:12
 * @Version 1.0
 */

@Configuration
@EnableOpenApi
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
// 指定构建api文档的详细信息的方法：apiInfo()
                .apiInfo(apiInfo())
                .select()
// 指定要生成api接口的包路径，这里把controller作为包路径，生成controller中的所有接口
                .apis(RequestHandlerSelectors.basePackage("com.controller"))
                .paths(PathSelectors.any())
                .build();
    }

/**
     * 构建api文档的详细信息
     * @return
     */

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
            // 设置页面标题
                .title("Spring Boot集成Swagger2接口总览")
            // 设置接口描述
                .description("电子商业票据系统")
            // 设置版本
                .version("1.0")
            // 构建
                .build();
    }
}

🚨 特别注意

3.0用的是@EnableOpenApi注解，而2.0用的是 @EnableSwagger2注意区分

启动项目，访问地址：http://localhost:8080/swagger-ui/index.html，(注意swagger2.x版本中访问的地址的为http://localhost:8080/swagger-ui.html)