Last two years I worked on Spring Boot Applications with Springfox. Springfox generate a documentation and a test ui for your REST API. This was awesome.
But actually Springfox project is dead and do not support the newest Spring. I have three questions
springdoc is a much more recent library that does not have so much legacy code as Springfox. As a consequence of the first one, springdoc is actually updated regularly and the amount of open issues is relatively small (only 11 vs 270 on Springfox).
Swagger2 is an open source project used to generate the REST API documents for RESTful web services. It provides a user interface to access our RESTful web services via the web browser. To enable the Swagger2 in Spring Boot application, you need to add the following dependencies in our build configurations file.
The Springfox suite of java libraries are all about automating the generation of machine and human readable specifications for JSON APIs written using the spring family of projects.
springfox-data-rest contains the integration that automatically creates a Swagger documentation for Spring Data REST repositories.
I haven't tried it myself yet, but this looks quite promising:
https://github.com/springdoc/springdoc-openapi
OpenAPI 3.0 is the successor of Open API 2.0 (sometimes referred to as Swagger, though that is actually the tooling around Open API). Not sure how much this project offers in terms of customization and how mature it is, but I guess it's worth a try ;-)
Update:
Since version 3, Spring Fox offers support for Open API 3. Please see the release log for more details.
Spring doc Open API is alternative going forward.
Refer the below link
https://techsparx.com/software-development/openapi/spring-boot-rest-api-docs.html
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With