November 2017
Intermediate to advanced
420 pages
10h 29m
English
Content preview from RESTful Java Web Services - Third Edition
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
Start your free trial
Generating Swagger from JAX-RS
Both the WADL and RAML tools that we discussed in the previous sections use the JAX-RS annotations metadata to generate the documentation for the APIs. The Swagger framework does not fully rely on the JAX-RS annotations but offers a set of proprietary annotations for describing the resources. This helps in the following scenarios:
- The Swagger core annotations provide more flexibility for generating documentations compliant with the Swagger specifications
- It allows you to use Swagger for generating documentations for web components that do not use the JAX-RS annotations, such as servlet and the servlet filter
The Swagger annotations are designed to work with JAX-RS, improving the quality of the API documentation ...