-
Notifications
You must be signed in to change notification settings - Fork 200
Module JAXRS
The JAX-RS module processes all the Java classes that support the JAX-RS framework. The JAX-RS module creates a model that is used to generate resource-based documentation for the API.
The configuration for the JAX-RS module is specified by the jaxrs element under the modules element in the Enunciate configuration file. The following attributes are supported on the jaxrs element:
| attribute | description |
|---|---|
groupBy |
The "groupBy" attribute dictates how the resources are grouped. Enunciate supports three ways to group resources: "class" (by resource class), "path" (by path), and "annotation" (by value of the @com.webcohesion.enunciate.metadata.rs.ResourceGroup annotation, requires Enunciate 2.1 or later). |
datatype-detection |
The "datatype-detection" dictates how the module is to detect data types for the API. The valid values are "passive" (data types will only be detected when other modules and services explicitly depend on the data types), "aggressive" (data types will be detected aggressively, by scanning the entire classpath), and "local" (data types will be detected only from among those in the source code of the current invocation context). Default is "local" unless explicit include patterns have been provided, in which case default is "aggressive". |
disableExamples |
(Since 2.7) Whether to disable examples in the generated documentation. Default: false. |
path-sort-strategy |
(Since 2.3) Whether to group paths by breadth_first or depth_first. Default: breadth_first. |
The jaxrs element supports the following child elements:
Some JAX-RS applications could be mounted at a subcontext of the application. This elements allows for Enunciate to be aware of the subcontext of the JAX-RS application. The application element supports a single attribute, path that specifies the subpath.
Some frameworks provide custom annotations that are used to inject framework-proprietary data into a JAX-RS method. The custom-system-parameter-annotation element provides a way to tell Enunciate about these custom annotations so Enunciate will know to ignore the parameters to which the annotations apply. The custom-system-parameter-annotation supports a single attribute, qualifiedName, that is used to provide the fully-qualified name of the annotation.
Some frameworks provide custom annotations that are used to describe a special kind of resource parameter. The custom-resource-parameter-annotation element provides a way to tell Enunciate about these custom annotations. Enunciate will make a best attempt to describe these parameters using the name of the annotation. The custom-resource-parameter-annotation supports a single attribute, qualifiedName, that is used to provide the fully-qualified name of the annotation.