Smallrye开放api拦截器

问题描述

我正在开发一个休息应用程序。

某些端点需要自定义标头参数，与授权无关。我使用 jax-rs NameBinding 创建了一个自定义注释。这是一个用法示例：

@GET
@RequiresBankHeader
public int get(
        @HeaderParam("bank")
        @Parameter(ref = "#/components/parameters/banks")
                String bank) {        
    return someService.getSome@R_499_4045@ion();
}

有一个提供程序拦截这个调用并使用标头参数中的信息执行一些例程。

问题是我必须到处重复 '@HeaderParam("bank") @Parameter(ref = "#/components/parameters/banks") String bank'，所以它出现在 Swagger 中，即使服务类不需要它。我至少能够使用 ref = "#/components/parameters/banks" 重用参数定义，并在 OpenAPI.yml 文件中声明它，Quarkus 与生成的代码非常好地合并。

但我也想创建和拦截器来动态添加这个做 OpenApi 定义每当 RequiresBankHeader 注释存在时。

有办法吗？

解决方法

我不认为您可以使用拦截器来修改生成的 Openapi 模式输出。如果给定端点上的所有方法都需要某个参数，您可以在类级别指定它，如下所示：

@Path("/someendpoint")
public class MyEndpoint {
  
    @HeaderParam("bank")
    @Parameter(name = "bank")
    String bank;

    @GET
    public Response getAll() {return Response.ok().build()}

    @GET
    @Path("{id}")
    public Response someMethod(@PathParam("id") String id) {return Response.ok().build();}
}

正如 Roberto Cortez 所提到的，MP OpenAPI 规范提供了一种向 openapi.yml 文件提供元数据的编程方式。

无法检测 JAX-RS 端点定义中的注释，但它足以自动执行我需要的操作。由于具有 RequiresBankHeader 的所有方法都返回相同的架构，因此我可以像这样破解它：

public class OpenApiConfigurator implements OASFilter {

@Override
public Operation filterOperation(Operation operation) {
    operation.getResponses().getAPIResponses().values().stream().
            map(APIResponse::getContent).
            filter(Objects::nonNull).
            map(Content::getMediaTypes).
            flatMap(mediaTypes -> mediaTypes.values().stream()).
            map(MediaType::getSchema).
            filter(Objects::nonNull).
            map(Schema::getRef).
            filter(Objects::nonNull).
            filter(ref -> ref.contains("the common response schema")).
            findAny().
            ifPresent(schema -> {
                ParameterImpl parameter = new ParameterImpl();
                parameter.setRef("#/components/parameters/banks");
                operation.addParameter(parameter);
            });
    return operation;
}

OpenApiConfigurator 应该在应用程序属性中配置，使用 mp.openapi.filter=com.yourcompany.OpenApiConfigurator

microprofile openapi quarkus smallrye swagger