swagger - 如何在 swagger doc 中记录 RSQL 过滤器？

Question

我查看是否有任何开箱即用或扩展支持，我没有看到任何。任何参考/方法都会有所帮助。

Answer 1

在 Swagger 相关库或 Swagger UI 中都没有开箱即用的支持。

有几个选项：

1. 使用提供的扩展/插件选项Springfox来读取您的控制器元数据并将支持的过滤器字段添加到您的查询参数描述中。它支持markdown.
2. 使用供应商扩展属性，以便它通过 Swagger YAML/JSON 传递支持信息。然后，自定义 Swagger UI 以读取该信息并在 Swagger UI 中显示一些动态下拉列表。