RESTful Java Web Services - Third Edition

Generating RAML from JAX-RS

In this section, you will learn how to generate the RAML file for your JAX-RS application. To generate the RAML file for JAX-RS, we use the jaxrs-to-raml-maven-plugin Maven plugin that comes as a part of RAML for the JAX-RS project (from MuleSoft Inc.). The source for RAML for JAX-RS is available at https://github.com/mulesoft/raml-for-jax-rs.

The jaxrs-to-raml-maven-plugin Maven plugin is capable of identifying the JAX-RS annotation, which you can set on the resource class, resource methods, and fields, and uses this metadata to generate the RAML file while building the source. The jaxrs-to-raml-maven-plugin Maven plugin supports the following set of JAX-RS annotations: @Path, @Consumes, @Produces, @QueryParam ...