HAL Documentation Maven Plugin

Generates API service documenation and JSON Schema files for HAL- and JAX-RS based RESTful services.

License	The Apache Software License, Version 2.0
Categories	Maven Build Tools
GroupId	io.wcm.caravan.maven.plugins
ArtifactId	hal-docs-maven-plugin
Last Version	0.5.0
Release Date	Jul 25, 2015
Type	maven-plugin
Description	HAL Documentation Maven Plugin Generates API service documenation and JSON Schema files for HAL- and JAX-RS based RESTful services.
Project Organization	wcm.io Caravan
Source Code Management	https://github.com/wcm-io-caravan/caravan-hal

Download hal-docs-maven-plugin

Filename	Size
hal-docs-maven-plugin-0.5.0.pom
hal-docs-maven-plugin-0.5.0.jar	38 KB
hal-docs-maven-plugin-0.5.0-sources.jar	12 KB
hal-docs-maven-plugin-0.5.0-javadoc.jar	35 KB

How to add to project

Apache Maven

<plugin>
    <groupId>io.wcm.caravan.maven.plugins</groupId>
    <artifactId>hal-docs-maven-plugin</artifactId>
    <version>0.5.0</version>
</plugin>

Dependencies

compile (13)

Group / Artifact	Type	Version
io.wcm.caravan : io.wcm.caravan.hal.docs	jar	0.5.0
io.wcm.caravan : io.wcm.caravan.hal.docs-annotations	jar	0.5.0
io.wcm.caravan : io.wcm.caravan.commons.stream	jar	1.0.0
org.apache.maven : maven-plugin-api	jar	3.0.5
org.apache.maven : maven-core	jar	3.0.5
org.codehaus.plexus : plexus-utils	jar	3.0.22
org.apache.commons : commons-lang3	jar	3.3.2
commons-io : commons-io	jar	2.4
org.apache.commons : commons-compress	jar	1.9
com.google.guava : guava	jar	15.0
com.fasterxml.jackson.module : jackson-module-jsonSchema	jar	2.5.3
com.thoughtworks.qdox : qdox	jar	2.0-M3
org.jsoup : jsoup	jar	1.8.2

provided (7)

Group / Artifact	Type	Version
org.apache.maven.plugin-tools : maven-plugin-annotations	jar	3.2
org.slf4j : slf4j-api	jar	1.7.6
org.apache.felix : org.apache.felix.scr.annotations	jar	1.9.12
org.osgi : osgi.annotation	jar	6.0.1
org.osgi : org.osgi.core	jar	6.0.0
org.osgi : org.osgi.compendium	jar	5.0.0
com.google.code.findbugs : annotations	jar	3.0.0

test (4)

Group / Artifact	Type	Version
junit : junit	jar	4.12
org.mockito : mockito-core	jar	1.10.19
org.apache.sling : org.apache.sling.testing.osgi-mock	jar	1.4.1-R1692452
org.slf4j : slf4j-simple	jar	1.7.6

Project Modules

There are no modules declared in this project.

wcm.io Caravan HAL

wcm.io Caravan - JSON Data Pipelining Infrastructure

Hypertext Application Language (HAL) Support.

Documentation: https://caravan.wcm.io/hal/
Issues: https://wcm-io.atlassian.net/
Wiki: https://wcm-io.atlassian.net/wiki/
Continuous Integration: https://github.com/wcm-io-caravan/caravan-hal/actions
Commercial support: https://wcm.io/commercial-support.html

Build from sources

If you want to build wcm.io from sources make sure you have configured all Maven Repositories in your settings.xml.

See Maven Settings for an example with a full configuration.

Then you can build using

mvn clean install

wcm.io Caravan

JSON Data Pipelining Infrastructure

Versions

Version
0.5.0 Jul 25, 2015