spring boot集成 swagger

最新推荐文章于 2024-08-17 12:33:42 发布

一只前进的蜗牛coder

最新推荐文章于 2024-08-17 12:33:42 发布

阅读量857

点赞数

CC 4.0 BY-SA版权

分类专栏： spring boot

本文链接：https://blog.youkuaiyun.com/cf1992612/article/details/74516325

spring boot 专栏收录该内容

1 篇文章

订阅专栏

本文详细介绍了如何在Spring Boot项目中配置Swagger2，包括配置类的实现方式、必要的依赖包引入以及一些常见问题的解决方案。

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

swagger 配置类



import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
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;

/**
 * swagger 配置类
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    public static final  String auth="";
    @Bean
    public Docket createRestApi() {

        ParameterBuilder aParameterBuilder = new ParameterBuilder();
        aParameterBuilder.name("Authorization").defaultValue(auth).name("Authorization").modelRef(new ModelRef("String")).parameterType("header").required(false).build();
        List<Parameter> aParameters = new ArrayList<Parameter>();
        aParameters.add(aParameterBuilder.build());

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .globalOperationParameters(aParameters)
                .select()
                .apis(RequestHandlerSelectors.basePackage(""))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("APIs")
                .version("2.0")
                .build();
    }

}

引入jar包

<!-- swagger --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.6.1</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.6.1</version> </dependency>

注意点：

	fastjson版本，1.1.12版本，启动后访问swagger 会出现fetching resource ... please wait ，这条提示。改为1.1.16，就好了。

	controller 类上需要添加 @RequestMapping("/")，前台会404，后台会提示o.s.web.servlet.PageNotFound - Request method 'GET' not supported