This library extends Spring HATEOAS with the custom hypermedia type Siren.
Siren: a hypermedia specification for representing entities
The media type for Siren is defined as application/vnd.siren+json.
If you want to add the library to your app, the first step is to determine the version of the library you should use. The table below outlines which version of the library maps to which version of Spring HATEOAS, Spring Boot and the Spring Framework.
| Spring HATEOAS Siren | Spring HATEOAS | Spring Boot | Spring Framework |
|---|---|---|---|
| 1.4.x | 1.5.x | 2.7.x | 5.3.x |
| 1.3.x | 1.4.x | 2.6.x | 5.3.x |
| 1.2.x | 1.3.x | 2.5.x | 5.3.x |
| 1.1.x | 1.2.x | 2.4.x | 5.3.x |
| 1.0.x | 1.1.x | 2.3.x | 5.2.x |
Please check section Setup of the documentation to understand how to integrate this library into your project. The RELEASE versions are available through Maven Central. The latest SNPASHOT version is available through the Sonatype Snapshots Repository.
A collection of examples that showcase how to use the features provided by the library can be found here.
Here you find the documentation for the latest releases and the current SNAPSHOT version:
| Version | Reference documentation | API documentation |
|---|---|---|
| SNAPSHOT | Reference Doc. | API Doc. |
| 1.3.0 | Reference Doc. | API Doc. |
| 1.2.0 | Reference Doc. | API Doc. |
| 1.1.0 | Reference Doc. | API Doc. |
| 1.0.3 | Reference Doc. | API Doc. |
If you are interested in the Reference/API documentation of a specific version which is not listed here, you simply need to apply the following rules.
The url to the Reference documentation has the following pattern:
<scheme>://<host>/spring-hateoas-siren/<version>/index.html
The value current is used for the path segment <version> if the url points to the Reference documentation of the current SNAPSHOT version.
The Reference documentation of a specific version can be addressed if the path segment <version> of the url is replaced with a specifc release version.
For example, the Reference documentation of version 1.0.0 can be addressed if the path segment <version> is replaced with 1.0.0.
The url to the API documentation has the following pattern:
<scheme>://<host>/spring-hateoas-siren/<version>/apidocs/index.html
The value current is used for the path segment <version> if the url points to the Reference documentation of the current SNAPSHOT version.
The Reference documentation of a specific version can be addressed if the path segment <version> of the url is replaced with a specifc release version.
For example, the Reference documentation of version 1.0.0 can be addressed if the path segment <version> is replaced with 1.0.0.
This code is open source software licensed under the Apache 2.0 License.