swagger-ui - swagger-ui：如何将 header-param 请求添加到每个 api

Question

我是 quarkus 的新手，对 swagger-ui 有点熟悉。我可以像这样将@Parameter 添加到端点：

@Parameter(in = ParameterIn.HEADER, required = true, name = "my-header-id")

但是，我想将此参数添加到每个端点。我怎样才能做到这一点？

我正在使用quarkus-smallrye-openapiui。

标签： swagger-uiquarkus

Answer 1

您可以在方法或类级别上指定参数。如果将参数定义为类字段，那么它将添加到相应端点的所有方法中：

@Path("/someendpoint")
public class MyEndpoint {
  
    @HeaderParam("my-header-id")
    @Parameter(name = "my-header-id")
    String myHeaderId;

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

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