Swagger实现动态条件注入与全局拦截功能详细流程

 更新时间:2023年01月30日 10:50:06   作者:毕小宝  
这篇文章主要介绍了Swagger实现动态条件注入与全局拦截功能详细流程,Swagger 可以提供 API 操作的测试文档,本文记录 Swagger 使用过程中遇到的小问题

背景

Swagger 可以提供 API 操作的测试文档,本文记录 Swagger 使用过程中遇到的两个小问题:

  • 全局响应结果进行包装后导致 Swagger 请求响应结果无法解析,如果项目中配置了 ResponseBodyAdvice 实现类,重写了 beforeBodyWrite 方法对响应结果进行统一时,应该排除 Swagger2 的两个 URL v2/api-docsswagger-resources
  • Swagger 注入条件区分测试和生产环境的配置的 ETL 不同语法对默认无配置的处理结果。

Swagger2 使用流程

Swagger 用法很简单,加入引用,一个配置就可以为应用提供接口测试界面。

第一步,引入依赖。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.0</version>
</dependency>
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>swagger-bootstrap-ui</artifactId>
    <version>1.8.5</version>
</dependency>

第二步,添加 Swagger 配置类。

@Configuration
@EnableSwagger2
@EnableSwaggerBootstrapUI
@ConditionalOnExpression("'${swagger.enable}'.equalsIgnoreCase('true')")
public class Swagger2Config {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("XXX 文档")
                .version("1.0")
                .build();
    }
}

第三步,为 Web 请求设置 Api 配置。

@GetMapping("/set")
@ApiOperation(value = "设置 Session")
public Object Index(HttpServletRequest request){
    request.getSession().setAttribute("userUid", "111111");
    return request.getSession().getAttribute("userUid");
}

条件配置分析

@ConditionalOnExpression("'${swagger.enable}'.equalsIgnoreCase('true')")

这种方式,表达式成立的条件有两项 swagger.enable 必须配置,且值为 true 时,才会成立。

另外一种写法:

@ConditionalOnExpression("${swagger.enable:true}")

如果未配置属性 swagger.enable,那么根据 ConditionalOnExpression 注解的默认值是 true ,所以就会执行注解配置。

启示录

为了方便开发测试,默认无配置时视为满足条件,生产环境下配置值为 false 是可以的。

到此这篇关于Swagger实现动态条件注入与全局拦截功能详细流程的文章就介绍到这了,更多相关Swagger动态条件注入内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 详解Java Selenium中的鼠标控制操作

    详解Java Selenium中的鼠标控制操作

    本文主要讲解如何用java Selenium 控制鼠标在浏览器上的操作方法。主要列举的代码示例,大家可以自己上代码执行操作看效果,希望对大家有所帮助
    2023-01-01
  • 详解spring boot应用启动原理分析

    详解spring boot应用启动原理分析

    这篇文章主要介绍了详解spring boot应用启动原理分析,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-06-06
  • JAVA8 List<List<Integer>> list中再装一个list转成一个list操作

    JAVA8 List<List<Integer>> list中再装一个list转成一个list操

    这篇文章主要介绍了JAVA8 List<List<Integer>> list中再装一个list转成一个list操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-08-08
  • Java反射机制的讲解

    Java反射机制的讲解

    今天小编就为大家分享一篇关于Java反射机制的讲解,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2019-04-04
  • 如何在springboot中引入参数校验

    如何在springboot中引入参数校验

    一般我们判断前端传过来的参数,需要对某些值进行判断,是否满足条件,而springboot相关的参数校验注解,可以解决我们这个问题,本文给大家介绍如何在springboot中引入参数校验,感兴趣的朋友一起看看吧
    2023-12-12
  • Java设计模式之桥接模式详解(Bridge Pattern)

    Java设计模式之桥接模式详解(Bridge Pattern)

    桥接模式是一种结构型设计模式,旨在将抽象部分与其实现部分分离,从而使两者可以独立地变化,桥接模式通过组合关系代替继承关系,将抽象和实现解耦,使代码更具扩展性和维护性
    2025-02-02
  • RabbitMQ简单队列实例及原理解析

    RabbitMQ简单队列实例及原理解析

    这篇文章主要介绍了RabbitMQ简单队列实例及原理解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-12-12
  • springboot 设置server.port不生效的原因及解决

    springboot 设置server.port不生效的原因及解决

    这篇文章主要介绍了springboot 设置server.port不生效的原因及解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-08-08
  • java使用ZipInputStream实现读取和写入zip文件

    java使用ZipInputStream实现读取和写入zip文件

    zip文档可以以压缩格式存储一个或多个文件,本文主要为大家详细介绍了java如何使用ZipInputStream读取Zip文档与写入,需要的小伙伴可以参考下
    2023-11-11
  • Java二叉树的四种遍历方式详解

    Java二叉树的四种遍历方式详解

    这篇文章主要介绍了Java二叉树的四种遍历,二叉树的遍历可以分为前序、中序、后序、层次遍历,需要的朋友可以参考下
    2021-11-11

最新评论