Skip to content
This repository has been archived by the owner on Feb 12, 2022. It is now read-only.

2.0.0

Compare
Choose a tag to compare
@jstoiko jstoiko released this 20 Apr 21:19

This release constitutes a major refactoring, pretty much everything has changed. The 2.0.x version adds support for RAML 1.0 which is now the target for both halves of the system: raml-to-jaxrs and jaxrs-to-raml. Note that in this version, raml-to-jaxrs supports both RAML 0.8 and 1.0 while jaxrs-to-raml supports RAML 1.0 only. To generate RAML 0.8, you should use version 1.3.x. Both packages can be ran as either command-line or maven plugin.

What's new in raml-to-jaxrs?

There are two fundamental changes. The first one is that it now uses JavaPoet to generate code. The second one is that it leverages annotations introduced in RAML 1.0 to extend the generation. This means that some features are only available if using RAML 1.0 as input.

You can find an exhaustive list of changes here: #211.

What's new in jaxrs-to-raml?

The main difference with the previous versions is that the output is now in RAML 1.0 format. This means that: JAXB schemas are translated to RAML data types and RAML examples can now be expressed using a custom @Examples annotations.

This release adds support for multipart files using @FormDataParam. It now translates @DefaultValue to default: RAML property. Also, note that unsupported annotations, i.e. annotations that are not understood by the program, can be preserved and converted to RAML annotations.

You can find an exhaustive list of changes here: #212.

Where to start?

The documentation for both raml-to-jaxrs and jaxrs-to-raml are a good starting point. There are also several examples in each package that demonstrates the main features.