About HAL Interface Documentation

Runtime support for interface documentation of HAL-based JAX-RS services.

Maven Central



For HAL-based RESTful services the REST URLs are not important, because all consumers follow only the HAL link relations. Thus there is need for a documentation for RESTful APIs that is based on link relations and not on URLs.

This bundle implementation an documentation support that can be generated automatically from the maven projects containing the service implementations and domain models and integrations nicely with the HAL Browser.

See Usage for a detailed description.

Back to top

Version: 0.6.1-SNAPSHOT. Last Published: 2022-09-02.