Search code examples
springspring-bootswaggerspringfoxspringdoc

What is the best way to document APIs in Spring boot project?

  1. Using SpringFox swagger
  2. springdoc-openapi https://springdoc.org/
  3. Using io.swagger.v3.oas.integration.SwaggerConfiguration
Solution

  • I would say this is borderline opinion-based but consider using springdoc. Springfox is so buggy at this point that is a pain to use. I've moved to springdoc 2 years ago because of its Spring WebFlux support and I am very happy about it. Additionally, it also supports Kotlin Coroutines, which I am not sure Springfox does.

    If you decide to use springdoc and you used Springfox in the past there is even a migration guide.