Plugin Documentation | HAL Documentation Maven Plugin

Goals available for this plugin:

Goal	Description
hal-docs:generate-hal-docs-json	Generates HAL documentation JSON files for service.
hal-docs:generate-json-schema	Generates JSON schema files for Java POJOs using Jackson 'jackson-module-jsonSchema'. The generated files are attached as resources and included in the JAR file.
hal-docs:help	Display help information on hal-docs-maven-plugin. Call `mvn hal-docs:help -Ddetail=true -Dgoal=<goal-name>` to display parameter details.

System Requirements

The following specifies the minimum requirements to run this Maven plugin:

Maven	3.0.5
JDK	11

Usage

You should specify the version in your project's plugin configuration:

<project>
  ...
  <build>
    <!-- To define the plugin version in your parent POM -->
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>io.wcm.caravan.maven.plugins</groupId>
          <artifactId>hal-docs-maven-plugin</artifactId>
          <version>0.6.0-SNAPSHOT</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>io.wcm.caravan.maven.plugins</groupId>
        <artifactId>hal-docs-maven-plugin</artifactId>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

For more information, see "Guide to Configuring Plug-ins"