Dear Spring-Team,

I love using Spring and I have recently started a new project where I want to use spring-data-rest with all its features and then generate a Swagger/OpenAPI file from it and further generate Angular client methods and model from that.

  • I found springdoc-openapi which doesn't support spring-data-rest at all
  • and springfox which doesn't support the finer details like Pages and Projections/Excerpts

My feature request is that you include a possibility to generate (machine-readable) API documentation directly into spring boot. This would make good API documentation much easier and would lead to very nice, generated client code, which can be generated for a lot of programming languages (see openapi-generator)

Comment From: wilkinsona

Thanks for the suggestion. We consider HTTP/RESTful API documentation to be out of scope of Spring Boot itself. That role is filled by the Spring REST Docs project for which Spring Boot provides some auto-configuration to help you when you're writing your tests. REST Docs itself does not have OpenAPI support although it has been considered in the past, but a third-party extension does.