8wDlpd.png
8wDFp9.png
8wDEOx.png
8wDMfH.png
8wDKte.png

Swagger UI 文档的分组路径和查询请求参数(Spring Boot)

Bhawna Bhardwaj 1月前

13 0

假设我得到了两个 GET 方法实现 @RestController@RequestMapping(\'/products/{id}\')public class ProductController { @GetMapping(path = \'/one\') pub...

假设我有两个 GET 方法实现

@RestController
@RequestMapping("/products/{id}")
public class ProductController {

    @GetMapping(path = "/one")
    public ResponseEntity<List<Product>> one(
            @Parameter(/* doc */) @PathVariable String id,
            @Parameter(/* doc */) @RequestParam(required = false) String query,
            @Parameter(/* doc */) @RequestParam(defaultValue = "0") Integer offset,
            @Parameter(/* doc */) @RequestParam(defaultValue = "10") Integer limit,
            @Parameter(/* doc */) @RequestParam(required = false) List<String> categories) {

        return ResponseEntity.noContent();
    }

    @GetMapping(path = "/two")
    public ResponseEntity<List<Product>> two(
            @Parameter(/* doc */) @PathVariable String id,
            @Parameter(/* doc */) @RequestParam(required = false) String query,
            @Parameter(/* doc */) @RequestParam(defaultValue = "0") Integer offset,
            @Parameter(/* doc */) @RequestParam(defaultValue = "10") Integer limit,
            @Parameter(/* doc */) @RequestParam(required = false) List<String> categories) {

        return ResponseEntity.noContent();
    }
}

我尝试过创建 record

record ProductParameters(
    @Parameter(/* doc */) @PathVariable String id,
    @Parameter(/* doc */) @RequestParam(required = false) String query,
    @Parameter(/* doc */) @RequestParam(defaultValue = "0") Integer offset,
    @Parameter(/* doc */) @RequestParam(defaultValue = "10") Integer limit,
    @Parameter(/* doc */) @RequestParam(required = false) List<String> categories) {}

但是在 Swagger UI 中,我得到了这些 one two 单个参数 productParameters ,并且在下面的 Schemas 中只有一个条目...它看起来像一个带有这个“解决方案”的请求主体。

您知道吗,如何在 Spring Boot 中对请求路径/查询参数进行分组以避免重复?当我有不同的项目(不是基于 Spring)时,我只是使用 @BeanParam 它。

帖子版权声明 1、本帖标题:Swagger UI 文档的分组路径和查询请求参数(Spring Boot)
    本站网址:http://xjnalaquan.com/
2、本网站的资源部分来源于网络,如有侵权,请联系站长进行删除处理。
3、会员发帖仅代表会员个人观点,并不代表本站赞同其观点和对其真实性负责。
4、本站一律禁止以任何方式发布或转载任何违法的相关信息,访客发现请向站长举报
5、站长邮箱:yeweds@126.com 除非注明,本帖由Bhawna Bhardwaj在本站《rest》版块原创发布, 转载请注明出处!
最新回复 (0)
返回
作者最近主题: