使用 Swagger/Springfox 和 Spring Boot 將查詢參數解組為 object

Question

我的 REST 服務中有一個搜索端點。 我正在使用 Spring Boot，所以我有一個 @RestController 設置，其中包含一個基於搜索查詢返回搜索結果的方法。 這是方法定義：

@ApiOperation(value = "Get global search results")
@RequestMapping(method = GET, produces = {"application/json"})
public SearchResults get(SearchQuery query) {
    ...
}

我希望 SwaggerUI 會在 ui 中將 SearchQuery 的字段顯示為單獨的查詢參數。 它沒有； 它只顯示一個通用的“查詢”參數。 如果我用 @RequestBody 注釋查詢，用戶可以向主體添加 json 有效負載，但這是一個 GET 請求——我希望用戶只使用查詢參數。

有任何想法嗎？

Answer 1

用@ModelAttribute注釋SearchQuery ，它應該可以按預期工作。

Answer 2

對於 Srpring 2.6.3 和 springdoc 1.6.6，在SearchQuery之前使用@ParameterObject注釋