swagger-ui：如何向每个 API 添加标头参数请求

如何解决swagger-ui：如何向每个 API 添加标头参数请求

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

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

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

我使用 quarkus-smallrye-openapi 作为用户界面。

解决方法

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

@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();}
}