有沒有辦法為 javax.ws.rs 中的所有端點定義查詢參數？

Question

我正在嘗試使用 javax.ws.rs 注釋來記錄一個已經存在的應用程序，以定義特定端點需要的標頭 (@HeaderParam) 和參數 (@QueryParam)。 此信息將用於為應用程序生成 swagger 頁面。

public Response SampleFunction(@RequestBody(...),
                               @QueryParam(...),
                               @HeaderParam(...),
                               @HeaderParam(...),
                               @HeaderParam(...),
                               etc etc etc){
   return doStuff()
}

我已經確定了一組所有端點都需要的“@HeaderParam”。 我需要知道是否有任何方法可以讓我只定義一次 @HeaderParam 並將該定義用於所有端點，並且由於這是一個已經存在的應用程序，我需要在不進行任何主要代碼重構的情況下進行此更改。

Answer 1

我們相信已經找到了解決這個問題的方法。 通過全局聲明 @HeaderParam，它們出現在所有端點上，而不必為每個端點重復聲明。 是這樣的：

@Path("/")
public class myClass{

   @HeaderParam("Parameter_one")
   @Parameter(example = "example_one)
   Type parameter_one

   @HeaderParam("Parameter_two")
   @Parameter(example = "example_two)
   Type parameter_two

   public Response SampleFunction(@RequestBody(...),
                              etc etc etc){
      return doStuff()
   }
}

在這種特殊情況下，Parameter_one 和 Parameter_two 將在所有端點的 Swagger 頁面上可用。