Skip to end of metadata
Go to start of metadata

Just the docs, please.

By default, Enunciate compiles, packages and otherwise integrates itself with your Web service application. The reason for this is to make life easier for the basic developer who doesn't want to have to care about deployment descriptors and configuration.

But there are often cases where you're already compiling and packaging up your own endpoints, and you'd just like to have Enunciate generate it's documentation and client-side libraries. No problem.

Maven

As of Enunciate 1.10, you can use "docs" goal of the the Enunciate Maven Plugin. For example, the following POM snippet will generate all documentation (including client-side libraries) and put them in the "target/docs" directory.

pom.xml

Maven "Site" Inclusion

As of Enunciate 1.17, you can also use the Maven plugin to include the generated documentation as part of the generated Maven site:

pom.xml

Non-Maven Users

The simple answer is that you export the "docs" artifact to a specified (existing) directory or to a file. (If you export it to a file, it will be exported as the zipped-up directory.)

Ant

If you using Ant, this exports the "docs" artifact to the target/docs directory.

build.xml
Labels:
  1. Jan 04, 2010

    FWIW, the <docsSubdir> parameter mentioned above doesn't actually seem to work in version 1.17. If you try to use it:

    Embedded error: Error rendering Maven report: Unable to generate web service documentation report
    Unable to export non-existing file C:\Users\MB011000\workspace\system-configuration-rest-server\target\enunciate\build\docs\enunciate

  2. Jul 15, 2010

    In the ant sample above it should better say

    build.xml

    Alternatively, if the "target/docs" directory exists, Enunciate will automatically unzip the artifact for you.