Skip to main content

Swagger Basics

One of the most useful features of Juneau is the ability to generate Swagger-based OPTIONS pages for self-documenting designs (i.e. REST interfaces that document themselves).

As described previously, the PetStore example provides an example of auto-generated Swagger JSON:

Swagger JSON

Using SwaggerUI, we're able to render that JSON as a Swagger user interface:

Swagger UI