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

相关文章

  • SpringBoot创建动态定时任务的几种方式小结

    SpringBoot创建动态定时任务的几种方式小结

    SpringBoot提供了多种实现定时任务的方式,包括使用@Scheduled注解、SchedulingConfigurer接口、TaskScheduler接口和Quartz框架,@Scheduled适合简单的定时任务,文中通过代码示例介绍的非常详细,需要的朋友可以参考下
    2024-10-10
  • Java实现二叉查找树的增删查详解

    Java实现二叉查找树的增删查详解

    二叉查找树(ADT)是一个具有对于树种的某个节点X,它的左节点都比X小,它的右节点都比X大的二叉树。本文将用Java实现二叉查找树的增删查,需要的可以参考一下
    2022-06-06
  • java 与web服务器链接的实例

    java 与web服务器链接的实例

    这篇文章主要介绍了java 与web服务器链接的实例的相关资料,使用net.Socket类sock.getInetAddress()方法获得与Web服务器连接,需要的朋友可以参考下
    2017-07-07
  • GSON实现Java对象与JSON格式对象相互转换的完全教程

    GSON实现Java对象与JSON格式对象相互转换的完全教程

    GSON是Google编写并在在GitHub上开源的Java序列化与反序列化JSON的类库,今天我们就来总结一下使用GSON实现Java对象与JSON格式对象相互转换的完全教程
    2016-06-06
  • java构造器复用方式

    java构造器复用方式

    这篇文章主要介绍了java构造器复用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-03-03
  • gradle安装配置以及使用最新方法

    gradle安装配置以及使用最新方法

    这篇文章主要给大家介绍了关于gradle安装配置以及使用的相关资料,Gradle是一个基于ApacheAnt和ApacheMaven概念的项目自动化构建开源工具,文中通过图文介绍的非常详细,需要的朋友可以参考下
    2023-11-11
  • 使用Java生成JWT令牌的示例代码

    使用Java生成JWT令牌的示例代码

    json-web-token简称java web令牌,也称作JWT,是一种可以实现跨域身份验证身份的方案,jwt不加密传输数据,但能够通过数据前面验证数据的未被篡改,本文给大家介绍了如何使用Java生成JWT令牌,需要的朋友可以参考下
    2024-04-04
  • springboot 自定义权限标签(tld),在freemarker引用操作

    springboot 自定义权限标签(tld),在freemarker引用操作

    这篇文章主要介绍了springboot 自定义权限标签(tld),在freemarker引用操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-09-09
  • Java中map内部存储方式解析

    Java中map内部存储方式解析

    这篇文章主要介绍了Java中map内部存储方式解析的相关内容,涉及其实现方式,以及对存储方式作了简单的比较,具有一定参考价值,需要的朋友可了解下。
    2017-10-10
  • 详解Java中的不可变对象

    详解Java中的不可变对象

    这篇文章主要介绍了Java中的不可变对象的相关知识,文中代码非常详细,帮助大家更好的理解和学习,感兴趣的朋友可以参考下
    2020-06-06

最新评论