DZone
Thanks for visiting DZone today,
Edit Profile
  • Manage Email Subscriptions
  • How to Post to DZone
  • Article Submission Guidelines
Sign Out View Profile
  • Post an Article
  • Manage My Drafts
Over 2 million developers have joined DZone.
Log In / Join
Please enter at least three characters to search
Refcards Trend Reports
Events Video Library
Refcards
Trend Reports

Events

View Events Video Library

Zones

Culture and Methodologies Agile Career Development Methodologies Team Management
Data Engineering AI/ML Big Data Data Databases IoT
Software Design and Architecture Cloud Architecture Containers Integration Microservices Performance Security
Coding Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
Culture and Methodologies
Agile Career Development Methodologies Team Management
Data Engineering
AI/ML Big Data Data Databases IoT
Software Design and Architecture
Cloud Architecture Containers Integration Microservices Performance Security
Coding
Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance
Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks

Because the DevOps movement has redefined engineering responsibilities, SREs now have to become stewards of observability strategy.

Apache Cassandra combines the benefits of major NoSQL databases to support data management needs not covered by traditional RDBMS vendors.

The software you build is only as secure as the code that powers it. Learn how malicious code creeps into your software supply chain.

Generative AI has transformed nearly every industry. How can you leverage GenAI to improve your productivity and efficiency?

Related

  • Update User Details in API Test Client Using REST Assured [Video]
  • Create User API Test Client With REST Assured [Video]
  • How to Make a REST API Call in Angular
  • Develop a Spring Boot REST API in AWS: PART 4 (CodePipeline / CI/CD)

Trending

  • Creating a Web Project: Caching for Performance Optimization
  • The End of “Good Enough Agile”
  • SaaS in an Enterprise - An Implementation Roadmap
  • How to Merge HTML Documents in Java
  1. DZone
  2. Software Design and Architecture
  3. Integration
  4. REST API — What Is HATEOAS?

REST API — What Is HATEOAS?

In this article, continue to learn about REST APIs and learn about HATEOAS.

By 
Ranga Karanam user avatar
Ranga Karanam
DZone Core CORE ·
Updated Nov. 25, 19 · Tutorial
Likes (22)
Comment
Save
Tweet
Share
87.9K Views

Join the DZone community and get the full member experience.

Join For Free

Tabby cat sleeping on a rug

REST API — What Is HATEOAS?

While viewing a web page, you can see data on the page and perform actions with it. How about a REST API? Typically, when you ask for a REST resource, you get the details of the resource back. How about sending the operations that you can do with the resource in the response?

You might also like:  RESTful Web Services With Spring Boot, Gradle, HATEOAS, and Swagger

We Learn

  • What is HATEOAS?
  • Why do you need to use HATEOAS?
  • When do you make use of HATEOAS?

REST API

This is the fifth article in a series of articles on REST APIs:

  • 1 - Introduction to REST API — RESTful Web Services
  • 2 - REST vs SOAP — A Few Perspectives
  • 3 - Designing a REST API — What Is Contract First?
  • 4 - Designing a REST API — What Is Code First Approach?

What Does HATEOAS Stand For?

The term HATEOAS stands for the phrase Hypermedia As The Engine Of Application State. To understand this further, we first need to understand the meaning of Hypermedia.

Have a look at the following web page:

Screenshot of a GitHub webpage

When the browser loads the page, you definitely can see all the content that the page has to offer. More interestingly, the page also allows you to perform a lot of actions around that data, such as:

  • Clicking on buttons (the green "Clone or Download")
  • Clicking on tabs (to view the "Issues", for instance)
  • and several more

Now let's look at how our REST API's behave:

If you look at a typical GET request to a RESTful server, such as this one:

Screenshot of code

The request to GET http://localhost:8080/users retrieves a set of three users' details in this case. Sending a request with GET http://localhost:8080/users/1 will retrieve details of just the first user.

Typically, when we perform a REST request, we only get the data and not any actions around it. This is where HATEOAS comes in the fill in the gap.

A HATEOAS request allows you to not only send the data but also specify the related actions:

Screenshot of code

This example was in the JSON format. An XML format for another example would look something like this:

Screenshot of code

When you send out this request to retrieve account details, you get both:

  • Account number and balance details
  • Links that provide actions to do a deposit/withdrawal/transfer/closure

With HATEOAS, a request for a REST resource gives me both data, and actions related to the data.

Why Do We Need HATEOAS?

The single most important reason for HATEOAS is loose coupling. If a consumer of a REST service needs to hard-code all the resource URLs, then it is tightly coupled with your service implementation. Instead, if you return the URLs, it could use for the actions, then it is loosely coupled. There is no tight dependency on the URI structure, as it is specified and used from the response.

A few significant topics related to HATEOAS are:

HAL — Hypertext Application Language

When you design a RESTful service, there is a need to specify how to return data and links corresponding to a request. HAL is a simple format that gives an easy, consistent way to hyperlink between resources in your REST API. Here is an example:

Screenshot of code

With HAL, you have a few categories of representations:

  • Links:Specified as a combination of
    • Target — Given as a URI
    • Relation — A name
  • Embedded Resources: Other resources contained within a given REST resource
  • State: The actual resource data

If you happen to use the Spring Framework to develop your REST service, then Spring HATEOAS is a good engine to use for your service.

Check out our video on this:

Summary

In this article, we looked at what HATEOAS stands for. With HATEOAS, responses to REST requests return not just the data, but also actions that can be performed with the resource. This helps in making the applications loosely coupled.

Further Reading

REST + MongoDB + HATEOAS?

HATEOAS REST Services With Spring

REST Web Protocols API

Published at DZone with permission of Ranga Karanam, DZone MVB. See the original article here.

Opinions expressed by DZone contributors are their own.

Related

  • Update User Details in API Test Client Using REST Assured [Video]
  • Create User API Test Client With REST Assured [Video]
  • How to Make a REST API Call in Angular
  • Develop a Spring Boot REST API in AWS: PART 4 (CodePipeline / CI/CD)

Partner Resources

×

Comments
Oops! Something Went Wrong

The likes didn't load as expected. Please refresh the page and try again.

ABOUT US

  • About DZone
  • Support and feedback
  • Community research
  • Sitemap

ADVERTISE

  • Advertise with DZone

CONTRIBUTE ON DZONE

  • Article Submission Guidelines
  • Become a Contributor
  • Core Program
  • Visit the Writers' Zone

LEGAL

  • Terms of Service
  • Privacy Policy

CONTACT US

  • 3343 Perimeter Hill Drive
  • Suite 100
  • Nashville, TN 37211
  • support@dzone.com

Let's be friends:

Likes
There are no likes...yet! 👀
Be the first to like this post!
It looks like you're not logged in.
Sign in to see who liked this post!