springboot集成swagger

最新推荐文章于 2025-04-29 12:59:17 发布

adan201212

最新推荐文章于 2025-04-29 12:59:17 发布

阅读量128

点赞数

分类专栏： springboot swagger 文章标签： spring boot swagger2

本文链接：https://blog.youkuaiyun.com/dandan201212/article/details/116459931

版权

springboot 同时被 2 个专栏收录

5 篇文章

订阅专栏

swagger

1 篇文章

订阅专栏

本文介绍了如何在SpringBoot项目中集成Swagger，包括添加Swagger依赖、配置Swagger配置类及页面路径，以便于生成详细的API文档并方便开发者查看和调用。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

springboot集成swagger

1.pom依赖

 	<properties>
        <java.version>1.8</java.version>
        <swagger.version>2.9.2</swagger.version>
        <knife4j.version>2.0.5</knife4j.version>
    </properties>
   <!--Swagger start-->
        <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>
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
            <version>${knife4j.version}</version>
        </dependency>
        <dependency>
            <groupId>io.swagger</groupId>
            <artifactId>swagger-annotations</artifactId>
            <version>1.6.2</version>
        </dependency>
        <dependency>
            <groupId>io.swagger</groupId>
            <artifactId>swagger-models</artifactId>
            <version>1.6.2</version>
        </dependency>
        <!-- Swagger end-->

2.配置swagger配置类

1.SwaggerConfig

import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;
import java.util.List;

/**
 * @Description knife4文档地址: https://doc.xiaominfo.com/knife4j/
 * @Author zhangdan
 * @Date 2020/9/16
 */
@Configuration
@EnableSwagger2
@EnableKnife4j

@Import(BeanValidatorPluginsConfiguration.class)
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {

        ParameterBuilder ticketPar = new ParameterBuilder();
        List<Parameter> pars = new ArrayList<>();
        ticketPar.name("Authorization").description("Authorization")
                .modelRef(new ModelRef("string")).parameterType("header")
                .required(false).build();
        pars.add(ticketPar.build());

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                 //配置扫描路径
                .apis(RequestHandlerSelectors.basePackage("com.zhangdan.controller"))
                .paths(PathSelectors.any())
                .build().globalOperationParameters(pars);
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //页面标题
                .title("垃圾箱监控接口文档")
                //描述
                .description("<div style='font-size:14px;color:red;'>垃圾箱监控接口文档 RESTful APIs</div>")
                //版本号
                .version("v1.0.0")
                .build();
    }

}

2.页面路径配置：SwaggerWebConfig

import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import springfox.documentation.spring.web.SpringfoxWebMvcConfiguration;

/**
 * @author zhangdan
 * @description
 * @date 2020/9/16 13:51
 */

@Configuration
@ConditionalOnClass(SpringfoxWebMvcConfiguration.class)
public class SwaggerWebConfig implements WebMvcConfigurer {

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
        //将所有/** 访问都映射到classpath:/static/ 目录下，若不加该配置，static下的页面将访问不到
        registry.addResourceHandler("/**").addResourceLocations("classpath:/static/");

    }

}