Module Spring Web

Spring Web Module

The Spring Web module processes all the Java classes that support the Spring Web API framework. The Spring Web module creates a model that is used to generate resource-based documentation for the API.

Configuration

The configuration for the Spring Web module is specified by the spring-web element under the modules element in the Enunciate configuration file. The following attributes are supported on the spring-web 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).
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.

Elements

The spring-web element supports the following child elements:

application

Some Spring Web applications could be mounted at a subcontext of the application. This elements allows for Enunciate to be aware of the subcontext of the Spring Web application. The application element supports a single attribute, path that specifies the subpath.