https://github.com/spring-projects/spring-hateoas

Spring HATEOAS - Library to support implementing representations for hyper-text driven REST web services.
https://github.com/spring-projects/spring-hateoas

Last synced: about 1 month ago
JSON representation

Spring HATEOAS - Library to support implementing representations for hyper-text driven REST web services.

• Host: GitHub
• URL: https://github.com/spring-projects/spring-hateoas
• Owner: spring-projects
• License: apache-2.0
• Created: 2012-05-07T15:18:47.000Z (about 13 years ago)
• Default Branch: main
• Last Pushed: 2025-04-17T15:30:38.000Z (about 2 months ago)
• Last Synced: 2025-05-08T20:55:45.971Z (about 1 month ago)
• Language: Java
• Homepage: https://spring.io/projects/spring-hateoas
• Size: 7.05 MB
• Stars: 1,054
• Watchers: 101
• Forks: 472
• Open Issues: 265
• Metadata Files:
  • Readme: README.adoc
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.adoc

Awesome Lists containing this project

• trackawesomelist - Spring HATEOAS (⭐1.1k) - Standalone and Spring support for building hypermedia-based APIs using HAL, HAL FORMS, Collection+JSON, ALPS and UBER. (Recently Updated / [Mar 08, 2025](/content/2025/03/08/README.md))

README

        
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]

image:https://jenkins.spring.io/buildStatus/icon?job=spring-hateoas%2Fmain&subject=main[link=https://jenkins.spring.io/view/SpringHATEOAS/job/spring-hateoas/]

image:https://jenkins.spring.io/buildStatus/icon?job=spring-hateoas%2F1.2.x&subject=1.2.x[link=https://jenkins.spring.io/view/SpringHATEOAS/job/spring-hateoas/]

image:https://jenkins.spring.io/buildStatus/icon?job=spring-hateoas%2F1.1.x&subject=1.1.x[link=https://jenkins.spring.io/view/SpringHATEOAS/job/spring-hateoas/]

image:https://jenkins.spring.io/buildStatus/icon?job=spring-hateoas%2F1.0.x&subject=1.0.x[link=https://jenkins.spring.io/view/SpringHATEOAS/job/spring-hateoas/]

image:https://jenkins.spring.io/buildStatus/icon?job=spring-hateoas%2F0.25.x&subject=0.25.x[link=https://jenkins.spring.io/view/SpringHATEOAS/job/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.

== 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 "/"

----

== Making a release

Release instructions can be found https://github.com/spring-projects/spring-hateoas/tree/main/etc/release.adoc[here].

== Resources

* https://spring.io/projects/spring-hateoas#learn[Reference documentation]

* https://spring.io/guides/gs/rest-hateoas/[Getting started guide]