Generating Swagger UI documentation for REST API

java swagger swagger-ui
user3767923 picture user3767923 · May 23, 2015 · Viewed 43.5k times · Source

I have my REST API developed using JAX-RS/Jersey in Java. I want to convert to/generate Swagger based UI documentation for it. Can anyone please tell me precise/steps in simple way on how to do so? I m sorry but, steps given on their site are little vague for me.

Answer

Ron picture Ron · May 26, 2015

There are several ways to integrate swagger-core with your application, but based on your description, I'd just follow the wiki page as described either by https://github.com/swagger-api/swagger-core/wiki/Swagger-Core-Jersey-1.X-Project-Setup-1.5 or https://github.com/swagger-api/swagger-core/wiki/Swagger-Core-Jersey-2.X-Project-Setup-1.5 depending on the Jersey version you use.

Those pages also link to a set of samples you can use for reference and see how they work. They also pull in swagger-ui directly into them so you can see a full set of interaction.

Related questions

How do you turn off swagger-ui in production

I have swagger plugged in to my spring boot application. Spring boot allows you to have property files for each environment that you have. Is there a way to disable swagger for a production environment?

Read More
Not able to get springfox-swagger-ui working with Spring MVC

I have spent a few days looking and have been unable to find a solution, most example deal with spring boot and gradle, I am only using spring mvc and maven. If I remove the springfox-swagger-ui dependency the app runs …

Read More
Use @ApiParam or @ApiModelProperty in swagger?

Both the following annotations work for adding metadata to swagger-ui docs. Which one should be prefered, and why? public class MyReq { @ApiModelProperty(required = true, value = "the persons name") @ApiParam(required = true, value = "the persons name") private String name; } @RestController public …

Read More