如何在 swagger 文档中记录 RSQL 过滤器?
How to document RSQL filters in swagger doc?
我查看了是否有开箱即用或扩展支持,但没有看到。任何 reference/approach 都会有所帮助。
Swagger 相关库或 Swagger UI 都没有开箱即用的支持。
有两个选项:
- 使用
Springfox
提供的 extension/plugin 选项读取您的控制器元数据并将支持的过滤器字段添加到您的查询参数描述中。它支持 markdown
.
- 使用供应商扩展属性,以便它通过 Swagger 传递支持信息 YAML/JSON。然后,自定义 swagger UI 以读取该信息并在 Swagger UI.
中显示一些动态下拉菜单
我查看了是否有开箱即用或扩展支持,但没有看到。任何 reference/approach 都会有所帮助。
Swagger 相关库或 Swagger UI 都没有开箱即用的支持。
有两个选项:
- 使用
Springfox
提供的 extension/plugin 选项读取您的控制器元数据并将支持的过滤器字段添加到您的查询参数描述中。它支持markdown
. - 使用供应商扩展属性,以便它通过 Swagger 传递支持信息 YAML/JSON。然后,自定义 swagger UI 以读取该信息并在 Swagger UI. 中显示一些动态下拉菜单