Module Swagger (Version 1)

Swagger Module

The Swagger deployment module generates a Swagger UI.

Configuration

The configuration for the Swagger module is specified by the swagger child element of the modules element of the enunciate configuration file.

attribute	description
dir	The "dir" attribute is used to specify the directory name for the Swagger UI in the deployed application. Default: "ui"
css	The "css" attribute is used to specify the file to be used as the cascading stylesheet for the HTML. If one isn't supplied, a default will be provided.
base	The "base" attribute specifies a gzipped file or a directory to use as the swagger ui base. If none is supplied, a default base will be provided.
groupRestResources	The "groupRestResources" attribute specifies the name of a facet by which resources are grouped together. Default: "org.codehaus.enunciate.contract.jaxrs.Resource".
applyBaseUriFilter	The "applyBaseUriFilter" attribute specifies whether there should be a servlet filter applied that dynamically configures the Swagger base uri according to where the Swagger UI is deployed.
defaultNamespace	The "defaultNamespace" attribute specifies the default namespace for data types. This effects the name of the data type—most data type names have a namespace prefixed to avoid naming collisions. If a defaultNamespace is provided, the prefix will be ommitted on data types in that namespace.
freemarkerProcessingTemplate	The "freemarkerProcessingTemplate" attribute specifies the file that is the freemarker processing template to use to generate swagger JSON. If none is supplied, a default one will be used.
freemarkerProcessingTemplateURL	The "freemarkerProcessingTemplateURL" attribute specifies the URL to the freemarker processing template to use to generate swagger JSON. If none is supplied, a default one will be used.

Elements

facets

Facet configuration for the module. See Facets.