3ad9904705
Experience has shown that simple names (e.g. `test-jdk8`) is easier to use than verbose ones (e.g. `Test (JDK 8)`). This helps a lot when using the fly CLI and when linking to badge icons.
61 lines
3.3 KiB
Plaintext
61 lines
3.3 KiB
Plaintext
image:https://spring.io/badges/spring-hateoas/ga.svg[link=https://spring.io/projects/spring-hateoas]
|
|
image:https://spring.io/badges/spring-hateoas/snapshot.svg[link=https://spring.io/projects/spring-hateoas]
|
|
image:https://badges.gitter.im/spring-projects/spring-hateoas.png[link=https://gitter.im/spring-projects/spring-hateoas]
|
|
|
|
= Spring HATEOAS
|
|
|
|
This project provides some APIs to ease creating REST representations that follow the https://en.wikipedia.org/wiki/HATEOAS[HATEOAS] principle when working with Spring and especially Spring MVC. The core problem it tries to address is link creation and representation assembly.
|
|
|
|
== Project Status
|
|
|
|
We go to great lengths to ensure smooth upgrades. We also seek to make your upgrade on major versions of Java can be as smooth
|
|
as possible.
|
|
|
|
Check the matrix below to see the status of supported versions:
|
|
|
|
.Build Status
|
|
[cols='2,1,1']
|
|
|===
|
|
| Job | `1.0` status (master) | `0.25` status (0.25.x)
|
|
|
|
| Test - JDK 8
|
|
| image:https://ci.spring.io/api/v1/teams/spring-data/pipelines/spring-hateoas/jobs/test-jdk8/badge[link="https://ci.spring.io/teams/spring-data/pipelines/spring-hateoas"]
|
|
| image:https://ci.spring.io/api/v1/teams/spring-data/pipelines/spring-hateoas-0.25.x/jobs/Test%20-%20JDK%208/badge[link="https://ci.spring.io/teams/spring-data/pipelines/spring-hateoas-0.25.x"]
|
|
|
|
| Test - JDK 8 and Spring 5.0 (snapshots)
|
|
| Requires Spring Framework 5.2+
|
|
| image:https://ci.spring.io/api/v1/teams/spring-data/pipelines/spring-hateoas-0.25.x/jobs/Test%20-%20JDK%208%20and%20Spring%205.0%20(snapshots)/badge[link="https://ci.spring.io/teams/spring-data/pipelines/spring-hateoas-0.25.x"]
|
|
|
|
| Test - JDK 8 and Spring 5.1 (snapshots)
|
|
| Requires Spring Framework 5.2+
|
|
| image:https://ci.spring.io/api/v1/teams/spring-data/pipelines/spring-hateoas-0.25.x/jobs/Test%20-%20JDK%208%20and%20Spring%205.1%20(snapshots)/badge[link="https://ci.spring.io/teams/spring-data/pipelines/spring-hateoas-0.25.x"]
|
|
|
|
| Test - JDK 11
|
|
| image:https://ci.spring.io/api/v1/teams/spring-data/pipelines/spring-hateoas/jobs/test-jdk11/badge[link="https://ci.spring.io/teams/spring-data/pipelines/spring-hateoas"]
|
|
| Not supported
|
|
|
|
| Test - JDK 13
|
|
| image:https://ci.spring.io/api/v1/teams/spring-data/pipelines/spring-hateoas/jobs/test-jdk13/badge[link="https://ci.spring.io/teams/spring-data/pipelines/spring-hateoas"]
|
|
| Not supported
|
|
|
|
| Build - Deploy to repo.spring.io
|
|
| image:https://ci.spring.io/api/v1/teams/spring-data/pipelines/spring-hateoas/jobs/build/badge[link="https://ci.spring.io/teams/spring-data/pipelines/spring-hateoas"]
|
|
| image:https://ci.spring.io/api/v1/teams/spring-data/pipelines/spring-hateoas-0.25.x/jobs/Build/badge[link="https://ci.spring.io/teams/spring-data/pipelines/spring-hateoas-0.25.x"]
|
|
|===
|
|
|
|
|
|
== Working with Spring HATEOAS
|
|
|
|
Since all commits are headlined with its github issue, git will treat it as a comment. To get around this, apply the following configuration to your clone:
|
|
|
|
[source]
|
|
----
|
|
git config core.commentchar "/"
|
|
----
|
|
|
|
== Resources
|
|
|
|
* Reference documentation - https://docs.spring.io/spring-hateoas/docs/current/reference/html/[html], https://docs.spring.io/spring-hateoas/docs/current/reference/pdf/spring-hateoas-reference.pdf[pdf]
|
|
* https://docs.spring.io/spring-hateoas/docs/current-SNAPSHOT/[JavaDoc]
|
|
* https://spring.io/guides/gs/rest-hateoas/[Getting started guide]
|