SpringBoot 2.3.12集成Swagger3.0

最新推荐文章于 2024-06-21 06:55:13 发布

qq_25262009

最新推荐文章于 2024-06-21 06:55:13 发布

阅读量345

点赞数 3

本文链接：https://blog.csdn.net/qq_25262009/article/details/137079807

版权

本文介绍了如何在SpringBoot2.3.12项目中集成Swagger3.0版本，包括添加Maven依赖，配置SwaggerDocket和ApiInfo，以及在启动类上启用OpenApi注解。解决因版本冲突导致的方法找不到错误。

摘要由CSDN通过智能技术生成

SpringBoot 2.3.12集成Swagger3.0

增加 maven 依赖

<!--    swagger配置依赖    -->
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-boot-starter</artifactId>
			<version>3.0.0</version>
			<exclusions>
				<exclusion>
					<groupId>org.springframework.plugin</groupId>
					<artifactId>spring-plugin-core</artifactId>
				</exclusion>
				<exclusion>
					<groupId>org.springframework.plugin</groupId>
					<artifactId>spring-plugin-metadata</artifactId>
				</exclusion>
			</exclusions>

		</dependency>
		<dependency>
			<groupId>org.springframework.plugin</groupId>
			<artifactId>spring-plugin-core</artifactId>
			<version>2.0.0.RELEASE</version>
		</dependency>
		<dependency>
			<groupId>org.springframework.plugin</groupId>
			<artifactId>spring-plugin-metadata</artifactId>
			<version>2.0.0.RELEASE</version>
		</dependency>

如果不增加 spring-plugin-core、spring-plugin-metadata 的额外配置， springfox 依赖的默认版本为 1.2.0 ，启动时会报方法找不到错误，因此需要额外指定 2.0.0 版本。

增加配置类

package com.everelegance.boccfc.channelcenter.be.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.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;


@Configuration
public class Swagger3Config {

    Boolean swaggerEnabled = true;


    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                // 是否开启
                .enable(swaggerEnabled)
                .select()
                // 指定接口的位置
                .apis(RequestHandlerSelectors.basePackage("com.xxx.xxxx"))
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 配置网站的基本信息
     *
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // 网站标题
                .title("xxxx服务接口文档")
                // 联系人信息
                .contact( new Contact("","", "xxx@qq.com"))
                // 版本号
                .version("1.0")
                // 描述
                .description("xxx")
                .build();
    }
}