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动态条件注入内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 使用Shiro实现登录成功后跳转到之前的页面

    使用Shiro实现登录成功后跳转到之前的页面

    这篇文章主要介绍了如何使用Shiro实现不同用户登录成功后跳转到不同主页,实现此功能目前比较好的方法是用ajax的方法登录,第二种方法是把用户未登录前的url存在session中,需要的朋友可以参考下
    2015-07-07
  • JAVA正则表达式校验qq号码的方法

    JAVA正则表达式校验qq号码的方法

    Java作为一种开发语言,有许多值得推荐的地方,但是它一直以来没有自带对正则表达式的支持。下面小编给大家带来了JAVA正则表达式校验qq号码的方法,需要的朋友参考下吧
    2018-04-04
  • 完美解决Logback configuration error detected的问题

    完美解决Logback configuration error detected的问题

    这篇文章主要介绍了完美解决Logback configuration error detected的问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-08-08
  • 使用SpringBoot自定义starter的完整步骤

    使用SpringBoot自定义starter的完整步骤

    这篇文章主要给大家介绍了关于使用SpringBoot自定义starter的完整步骤,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-10-10
  • Java设计模式之代理模式

    Java设计模式之代理模式

    这篇文章介绍了Java设计模式之代理模式,文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-09-09
  • java中stringbuffer线程安全分析实例详解

    java中stringbuffer线程安全分析实例详解

    在本篇文章里小编给大家整理的是一篇关于java中stringbuffer线程安全分析实例详解内容,有兴趣的朋友们可以学习下。
    2021-01-01
  • Java 线程相关总结

    Java 线程相关总结

    这篇文章主要介绍了Java 线程的相关资料,帮助大家更好的理解和学习使用Java,感兴趣的朋友可以了解下
    2021-02-02
  • 解析Spring Cloud Bus消息总线

    解析Spring Cloud Bus消息总线

    这篇文章主要介绍了Spring Cloud Bus消息总线的介绍及使用,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-10-10
  • Java 的抽象类原理与用法分析

    Java 的抽象类原理与用法分析

    这篇文章主要介绍了Java 的抽象类原理与用法,结合实例形式分析了java抽象类与接口的相关概念、原理、使用方法及操作注意事项,需要的朋友可以参考下
    2019-12-12
  • Java使用Spring JdbcTemplate向in语句中传递参数的教程详解

    Java使用Spring JdbcTemplate向in语句中传递参数的教程详解

    这篇文章主要给大家介绍Java如何使用Spring JdbcTemplate向in语句中传递参数,文中有详细的流程步骤和代码示例,需要的朋友可以参考下
    2023-07-07

最新评论