Knfie4j openapi3 基于Operation注解暴露接口

最新推荐文章于 2024-08-16 16:40:12 发布

98Kming

最新推荐文章于 2024-08-16 16:40:12 发布

阅读量594

点赞数 8

文章标签： java

本文链接：https://blog.csdn.net/Kming98/article/details/134960745

版权

本文介绍了如何使用Knfie4jopenapi3库，通过@Operation注解来筛选并仅暴露指定的接口。通过自定义继承OpenApiWebMvcResource的类，重写isMethodToFilter方法，实现了接口的动态过滤。Maven依赖于knife4j-openapi3-spring-boot-starter版本4.3.0。

摘要由CSDN通过智能技术生成

Knfie4j openapi3 基于Operation注解暴露接口

记录下只暴露被Operation注解修饰的接口的方法

maven 依赖

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-openapi3-spring-boot-starter</artifactId>
    <version>4.3.0</version>
</dependency>

自定义类继承 OpenApiWebMvcResource 类，该类是knfei4j接口文档的控制器，重写 isMethodToFilter 方法，该方法判断接口是否显示
isMethodToFilter 方法的解释

@Override
    protected boolean isMethodToFilter(HandlerMethod handlerMethod) {
        return handlerMethod.hasMethodAnnotation(Operation.class) && super.isMethodToFilter(handlerMethod);
    }

效果

之前

在这里插入图片描述

之后

在这里插入图片描述

整个类代码：

import io.swagger.v3.oas.annotations.Operation;
import org.springdoc.core.*;
import org.springdoc.core.customizers.SpringDocCustomizers;
import org.springdoc.webmvc.api.OpenApiWebMvcResource;
import org.springframework.beans.factory.ObjectFactory;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.method.HandlerMethod;

/**
 * 2023-12-12 21:56
 */
@RestController
public class OpenApiWebMvcResourceX extends OpenApiWebMvcResource {
    public OpenApiWebMvcResourceX(ObjectFactory<OpenAPIService> openAPIBuilderObjectFactory, AbstractRequestService requestBuilder, GenericResponseService responseBuilder, OperationService operationParser, SpringDocConfigProperties springDocConfigProperties, SpringDocProviders springDocProviders, SpringDocCustomizers springDocCustomizers) {
        super(openAPIBuilderObjectFactory, requestBuilder, responseBuilder, operationParser, springDocConfigProperties, springDocProviders, springDocCustomizers);
    }

    @Override
    protected boolean isMethodToFilter(HandlerMethod handlerMethod) {
        return handlerMethod.hasMethodAnnotation(Operation.class) && super.isMethodToFilter(handlerMethod);
    }
}