DOCSEARCHbyAlgolia
Submit Docs

Enunciate Documentation

repository·master·Indexed 19 days ago

https://github.com/stoicflame/enunciate

A build-time tool for Java projects that analyzes Web service endpoint source code to automatically generate artifacts, including documentation and client libraries.

Tokens
294
Snippets
2
Records
3
Agent score
17%

What's inside Enunciate

  1. What is Enunciate

    master
    Enunciate is a build-time Web service enhancement tool designed for Java-based projects. It analyzes the source code of your Web service endpoints to automatically generate various artifacts, such as documentation and client libraries.

  2. Install dependencies for a full Enunciate build on Ubuntu

    master

    If you are performing a "full" build on Ubuntu to support client-side code testing, you must install the following system packages to provide support for libxml2, Mono (C#), GNUStep (Objective-C), Ruby, Node.js, and PHP:

    sudo apt-get install libxml2-dev mono-devel gnustep gnustep-devel ruby ruby-dev nodejs php php-xml

  3. Build Enunciate from source

    master

    To build Enunciate, you must use Java JDK 17. Ensure your JAVA_HOME environment variable points to the JDK 17 installation path before executing Maven commands.

    For a standard build, run:

    export JAVA_HOME=/PATH/TO/JDK/17
mvn clean install

    Note: A "full" build (required for deployment) includes tests for generated client-side code. This requires additional system-level libraries for C/C++, Objective-C, and C#.