documentation home

Choosing a Rest Framework

Since Miredot 1.6, we support both the JAX-RS and Spring-MVC specification. By default Miredot only scans for JAX-RS interfaces. If you are using Spring-MVC, you will need to set the restFramework configuration parameter explicitly.

The restFramework configuration parameter can have one of these values:

  • jax-rs
  • spring-mvc

If you are using Apache CXF, you will also have to provide cxf-specific configuration.

An example configuration for Maven and Gradle can be found below:

Maven:
<configuration>
    <restModel>
        <restFramework>
            <name>spring-mvc</name>
        </restFramework>
    </restModel>
</configuration>
Gradle:
restModel {
    restFramework{
        name = 'spring-mvc'
    }
}

For more information regarding annotation support for these frameworks, please consult the Supported Frameworks page.