Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

support @EnableSpringDataWebSupport(pageSerializationMode = EnableSpringDataWebSupport.PageSerializationMode.VIA_DTO) #2625

Closed
zyro23 opened this issue Jun 15, 2024 · 0 comments · Fixed by #2626

Comments

@zyro23
Copy link

zyro23 commented Jun 15, 2024

Is your feature request related to a problem? Please describe.

starting with spring-boot-3.3.0 / spring-data-commons-3.3.0, you can choose to use PagedModel<T> (part of spring-data's public api) as (default) response representation of spring-data's Page<T> interface.

ref. https://docs.spring.io/spring-data/commons/reference/repositories/core-extensions.html#core.web.page.config

adding @EnableSpringDataWebSupport(pageSerializationMode = EnableSpringDataWebSupport.PageSerializationMode.VIA_DTO) does not change springdoc's behavior - it still uses the Page interface to infer the response representation (which kinda makes sense given it is still the controller method return type)..

Describe the solution you'd like

it would be nice if springdoc would support PageSerializationMode.VIA_DTO, e.g. by making it aware of SpringDataWebSettings.pageSerializationMode or by some means of configuration.

Describe alternatives you've considered

  • works (although not always desirable):
    • using PagedModel explicitly (i.e. changing controller return type from Page<T> to PagedModel<T>) and returning new PagedModel<>(myPage)
  • does not work:
    • adding @ApiResponse(content = @Content(schema = @Schema(implementation = PagedModel.class)))
      • this does not respect generics - i.e. it results in one PagedModel<?> schema (content: any[]) instead of specific representations tied to the contained type like it works for Page<T> (e.g. Page<Person> -> PagePerson schema (content: Person[]))
    • using SpringDocUtils.getConfig().replaceWithClass(Page.class, PagedModel.class)
      • this does not respect generics as well - same problem as above

Additional context

n/a

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant