The Swagger-core open source project allows you to create documentation for your REST endpoints. During the installation process, all of the required Swagger libraries are available, allowing you to configure and use Swagger annotations in your endpoint classes.
Swagger produces documentation in JSON or YAML format, and can be accessed through the URL in the format of http://
server
:
port
/
context
/
servletpath
/swagger.json|yaml
. For example, you could access a JSON file from http://localhost:8080/public/v1/swagger.json
.
Swagger is initiated on server startup and can be configured to scan specific packages or classes, looking for JAX-RS and Swagger annotation. Swagger has been extended to retrieve a list of classes from the RestResourceRegistry
to scan. Swagger has also been extended to generate most of the endpoint request body and response schema information from the PayloadSchemaRegistry
configuration, specifically the payloadSchema.xml
.