Validating RADL Descriptions - restful-api-description-language/RADL GitHub Wiki

Running the validation tool

The radl.core.validation.RadlValidator class implements RADL validation. This class supports the following arguments:

  • The output report file name. Defaults to build/radl-issues.xml
  • The output report format. Defaults to checkstyle.
  • One or more file names of RADL descriptions to validate

Validation issues are reported in CheckStyle format to make it easy to add validation to your Continuous Integration build. The easiest way to do this is using the RADL Gradle plugin. A Maven RADL plugin is also available.

Adding output report formats

Output formats are implemented by the IssueReporter interface. To add an output format, add a class that implements this interface, and make it available using Java's SPI framework.