Module JS Client - stoicflame/enunciate GitHub Wiki
The JavaScript client module generates the client-side libraries that will access the JSON Web service API.
The JavaScript client module is configured by the javascript-client element under the modules element of the enunciate configuration file. It supports the following attributes:
| attribute | description |
|---|---|
slug |
The "slug" attribute is used to determine the name of the client-side artifact files. The default is the Enunciate project slug. |
global |
The "global" attribute is used to define the global name in the browser. |
The javascript-client element supports the following child elements:
The "package-conversions" subelement of the "javascript-client" element is used to map packages from the original API packages to different JS namespaces. This element supports an arbitrary number of "convert" child elements that are used to specify the conversions. These "convert" elements support the following attributes:
- The "from" attribute specifies the package that is to be converted. This package will match all classes in the package as well as any subpackages of the package. This means that if "org.enunciate" were specified, it would match "org.enunciate", "org.enunciate.api", and "org.enunciate.api.impl".
- The "to" attribute specifies what the package is to be converted to. Only the part of the package that matches the "from" attribute will be converted.
Facet configuration for the module. See Facets.