springdoc-v2中在不配置@ParameterObject的情况下实现Pageable以及Sort对象到API参数的转换
· 5 min read
springdoc是一个可以快速生成API文档的第三方公共库, 并提供了UI页面以供访问.
同时它也提供了spring-webmvc中的handler中的参数对象到API参数的转换.
对于spring-data-commons中的Pageable和Sort, springdoc提供了开箱即用的功能,
需要在配置文件中启用以及在参数中声明@ParameterObject
application.yml
springdoc:
model-converters:
pageable-converter:
enabled: true
对于已经存在的项目, 当刚引入springdoc时, 需要配置大量的@ParameterObject注解以实现参数转换功能.
这个过程通常比较繁琐, 因为对于一个具有一定规模的项目而言, 其对外提供的API往往会非常多,
需要进行大量的修改功能才能实现该功能
那么此时我们需要一种解决方案, 即如何在不配置@ParameterObject的情况下实现Pageable以及Sort对象到API参数的转换