iq-scm / raml-for-jax-rs

This project is all about two way transformation of JAX-RS-annotated Java code to RAML API description and back.

RAML for JAX-RS

Introduction

The goal of RAML for JAX-RS is to provide a set of tools to work with these technologies in a way of being able to scaffold a JAVA + JAX-RS application based on an existing RAML API definition (Code Generation), or its roundtrip, generate the RAML API definition based on an existing JAVA + JAX-RS application (Documentation).

Documentation

There are two projects:

• jaxrs-to-raml; and
• raml-to-jaxrs.

NOTE: raml-to-jaxrs supports both RAML 0.8 and 1.0. jaxrs-to-raml supports RAML 1.0 only, to generate RAML 0.8, you can use version 1.3.x of raml-for-jax-rs.

Maven artifacts

Maven artifacts are available at:

• https://repository-master.mulesoft.org/releases/ - releases repository
• https://repository-master.mulesoft.org/snapshots/ - snaphots repository

Releases are also available on Maven Central.

Contributing

If you are interested in contributing some code to this project, thanks! Please submit a Contributors Agreement acknowledging that you are transferring ownership.

To discuss this project:

• bug/feature request: please file a github issue
• If you're not sure: you can use the RAML forum or Slack