Just like how we use Javadoc to generate documentation for SDKs from source code with the comments(where we explain the classes,methods through comments). Can we use swagger tool to achieve the same?
Hi divya-gariga ,
Swagger or OpenAPI (that's the name of the specification) is about describing your RESTful APIs.
You can create those in different ways, by hand (it's a YAML file) and various integrations.
Once you have it, you can use it to generate SDKs, code stubs and documentation, or use it in a bunch of different ways.
If you're looking to describe your Java API into OpenAPI, the two options I know of are for JAX-RS and Spring (Boot).
- JAX-RS: https://github.com/swagger-api/swagger-core/wiki/Swagger-Core-Jersey-2.X-Project-Setup-1.5
- Spring Boot: https://www.baeldung.com/spring-rest-openapi-documentation
If you're looking to describe some other language, there are likely integrations for those too.
If you're interested in something similar to JavaDoc, I did come across https://github.com/bee-travels/openapi-comment-parser which looks promising, but I haven't tried it out.
