enunciate

articulate your web api.

Modules

The work of Enunciate is divided into modules. Modules can be thought of as loosely coupled, loosely-interdependant extensions to the Enunciate engine. Each module has a specific set of work to perform. For example, the XML module generates the WSDL and schemas for the API, the JAX-WS client module generates the Java client libraries, etc. Since each module has a specific set of work to do, each module has also a separate set of configuration options.

The modules that are to be included in the Enunciate mechanism are discovered at runtime using Sun's discovery mechanism.

There is a "base" set of modules that you will likely always want enabled. The "base" set is designed to enable the largest number of Enunciate features with a minimal dependency footprint. There are other "optional" modules that can be enabled according to the additional features that need to be applied. When invoking Enunciate, you will need to remember to add the necessary optional modules to the Enunciate classpath. For more information, see invoking Enunciate

Base Modules

  • basic-app

    Assembles a basic J2EE web application (war) according to the Enunciate configuration.

  • c

    Builds the C client libraries used to access the API.

  • csharp

    Builds the C# client libraries used to access the API.

  • docs

    Generates the API documentation.

  • java-client

    Builds the Java client libraries used to access the API.

  • jaxws-ri

    Generates support classes for deploying SOAP endpoints using JAX-WS RI.

  • jaxws-support

    Generates the support files and classes necessary to support a JAX-WS application according to the JAX-WS specification.

  • jersey

    Generates the support for deploying your endpoints according to the JAX-RS specification using Jersey.

  • obj-c

    Builds the Objective C client libraries used to access the API.

  • php

    Builds the PHP client libraries used to access the API.

  • xml

    Generates the WSDL and schemas for the API.

Optional Modules

  • amf

    Builds the AMF endpoints (and ActionScript client libraries for Flex developers) used to access the API via AMF. It also compiles the configured Flex applications.

  • CXF*

    Support for using CXF as the SOAP and JAX-RS engine.

  • gwt

    Builds the GWT client libraries used to access the API via GWT-RPC. It also compiles the configured GWT applications.

  • spring-app

    Enables the API to run in the Spring container so as to be able to take advantage of things like dependency injection and AOP.

  • swagger

    Builds the Swagger UI for the project.

*Since the default SOAP engine is JAX-WS RI and the default JAX-RS engine is Jersey, you will need to disable the jaxws-ri and jersey modules in order to use the CXF module. You will also need to enable the spring-app module since CXF depends on Spring. See these instructions for more information.

For more information about modules (including how to write your own), see the architecture guide.

Flattr this