spring boot 2.7 集成 swagger 3

spring boot 2.7 集成 swagger 3
记录一下

  1. 依赖
    spring boot 版本 2.7.3
 		<dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>
  1. 配置文件,生产环境关闭,测试环境开启
springfox:
  documentation:
    enabled: true
  1. 配置 SwaggerConfig
@EnableOpenApi
@Configuration
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.OAS_30)
            .apiInfo(apiInfo())
            .groupName("Normal")
            .enable(true)
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.tcoding.demo.helloworld.controller"))
            .paths(PathSelectors.any())
            .build()
            .pathMapping("/");
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
            //标题
            .title("Spring Boot中使用Swagger3构建RESTful APIs")
            //简介
            .description("")
            //服务条款
            .termsOfServiceUrl("")

            //作者个人信息
            .contact(new Contact("tc", "", "1043023220@qq.com"))
            //版本
            .version("1.0").build();
    }
}



spring MVC配置。不配这个起不来,就翻了一下swagger的代码

@Configuration
public class SpringMmcConfig extends DelegatingWebMvcConfiguration {

}

spring.factories 文件内容是,自动引入 OpenApiAutoConfiguration 配置类
在这里插入图片描述

OpenApiAutoConfiguration 引入 SwaggerUiWebMvcConfiguration在这里插入图片描述
SwaggerUiWebMvcConfiguration 注入了 SwaggerUiWebMvcConfigurer

在这里插入图片描述
SwaggerUiWebMvcConfigurer里面设置静态资源路径
在这里插入图片描述

SwaggerUiWebMvcConfiguration 里面初始化的bean 在 DelegatingWebMvcConfiguration里用到了

在这里插入图片描述

如果不使用

@Configuration
public class SpringMmcConfig extends DelegatingWebMvcConfiguration {

}

这个配置,则资源静态化配置不生效

源码连接

https://github.com/googalAmbition/hello-spring-boot/tree/main/04-swagger
3的访问地址是: /swagger-ui/index.html
2的访问地址是 : /swagger-ui.html

  • 7
    点赞
  • 8
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 3
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 3
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

tcoding

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值