Flat Preloader Icon


Spring HATEOAS is a part of the Spring Framework ecosystem that simplifies the implementation of hypermedia-driven RESTful web services following the principles of HATEOAS (Hypertext as the Engine of Application State). HATEOAS is an architectural constraint for RESTful APIs that promotes the inclusion of hypermedia links in responses, enabling clients to discover and navigate the available resources dynamically.

Key features and components of Spring HATEOAS include:

  • Resource Assemblers: Spring HATEOAS provides resource assembler classes that help you convert domain objects into HATEOAS-compliant resources. These resources include not only data but also links that allow clients to navigate to related resources.
  • Resource Support: The Resource and Resources classes provided by Spring HATEOAS represent resources and collections of resources, respectively. These classes encapsulate both the data and links associated with a resource.
  • ControllerLinkBuilder: This class simplifies the creation of links in your controller methods. It allows you to generate links based on the method’s return type and the controller’s base URL.
  • Link Relation Types: Spring HATEOAS defines a set of standard link relation types that you can use in your RESTful APIs, such as self, next, prev, first, and last, among others.
  • Link Building and Embedding You can add links to resources and embed related resources easily using Spring HATEOAS. This helps clients discover and interact with the API more effectively.
  • Here’s a simple example of how Spring HATEOAS can be used in a Spring MVC controller:

    public class MyController 
     public ResponseEntity
     <Resource<MyResource>> getResource
     (@PathVariable Long id)
          MyResource resource =
          // Retrieve the resource from the database
          Resource<MyResource> resourceWithLinks 
          = new Resource <>(resource);

    In this example, the Resource class from Spring HATEOAS is used to wrap the MyResource domain object, and a self-link is added to the resource. When a client accesses this endpoint, they receive not only the resource data but also a link that points to the same resource, allowing for easy navigation.

    Spring HATEOAS is particularly useful when building APIs where the client needs to discover the available resources and their relationships dynamically. It promotes the idea that the API should guide the client on how to interact with it, reducing the need for clients to hard-code URLs or endpoints. This results in more flexible and maintainable APIs that can evolve over time without breaking client applications.

    You can integrate Spring HATEOAS into your Spring Boot or Spring MVC applications by adding the appropriate dependencies to your project’s build file, such as spring-boot-starter-hateoas.

    Share on: