Skip to main content

HATEOAS for REST APIs

What is HATEOAS?

HATEOAS stands for Hypermedia as the Engine of Application State which is a constraint of the REST application architecture.

 REST APIs has no service definition and no formal documentation. The best REST APIs don't need any documentation.

 Just like websites have navigation from one page to another, REST APIs are able to do the same using HATEOAS.

 In HATEOAS the response will carry links that provide links as to where to find the related resources.

 This will let clients know all the things they can do with the received response and make the response navigable.

 Eg: An user object may contain the URI to itself. 

 
{
    "name": "John Doe",
    "links": [ {
        "rel": "self",
        "href": "http://localhost:8080/users/1"
    } ]
}
'rel' attribute here defines the relationship.

 If we take a status object of a particular social network site, it could be represented as below.

 
{
   "title": "Hello World",
   "id": 40,
   "author": "John Doe",
   "links": [ {
                "rel": "profile",
                "href": "http://localhost:8080/profiles/1"
            } 
            {
                "rel": "comments",
                "href": "http://localhost:8080/status/40/comments"
            } ]
}
If the client requires the link to the comments of a particular status it is included here and will help the client navigate easily without having to figure it out.

Similar to how hypertext will navigate us through websites, Hypermedia will drive the client's interaction through the application state and hence called Hypermedia as the Engine of Application State.

This approach is basically how HAL is used in APIs.[2]

When to use it?

HATEOAS is used in hypermedia-driven sites. 

 A hypermedia site is a site that contains non linear information(graphics, audio, video etc.). It provides information to navigate the site's REST interfaces dynamically by including hypermedia links in the response.

 This approach is not followed in SOA based systems usually as they have a fixed specification.

Why should we use it?

This approach will allow our API consumers know how to navigate through the API without any documentation and will not require them to hard code any URL to any related resource, instead it can be easily taken from the previous response.

 How Paypal API uses this approach can be found at [1].

 [1] https://developer.paypal.com/docs/api/hateoas-links/
[2] http://stateless.co/hal_specification.html

Labels

Labels:

Comments

Post a Comment

Popular posts from this blog

Admin panel of a Q & A Forum

In a Q & A Forum, when a user posts a question, it should be sent to the administrator for approval in case it contains inappropriate content. After approval it should be removed from this pending approval page and other users should be able to see the question afterwards. To enable this, we should maintain an approval column in our database table of records and for each record approval should be set to false by default. In the Pending approvals page only the records with approval=false should be displayed. Below is  the MySQL  statement for retrieval, $sql="SELECT * FROM topics WHERE approval=false"; To know which post was approved we should embed the post_id to the URL. And the relevant post should be updated as approval=true. Below is the complete code. <?php $sql="SELECT * FROM topics WHERE approval=false"; $query=mysqli_query($conn,$sql); echo '<form name="approve" method="p...
Post a Comment
Read more

Fixing 'java RMI - ConnectException: Operation timed out' in WSO2 Enterprise Integrator 6.4

If you ever come across the below exception when running WSO2 Enterprise Integrator 6.4, here is the fix. This error occurs when you have multiple IP addresses from different networks configured in your etc/hosts as below. 10.xxx.x.xxx localhost 192.xxx.x.xxx localhost So simply, removing the unnecessary one and leaving the one of the network that you are currently connected to should resolve this issue. 10.xxx.x.xxx localhost
Post a Comment
Read more

Calculator using PHP

This Calculator model will take inputs from the Number 1 and Number 2 fields and when the user clicks on the relevant operator the result will be displayed in the Results field. For log10(), to radian, to degree, sin, cos, tan operations only require one input. Hence, the user is instructed to input the values to the 1st field only. First, before proceeding with the calculation, we need to obtain the values from the text boxes. For that we should include all the form elements inside a form. The result is directed to the same page. Therefore we will use the form action as $_SERVER['PHP_SELF'] and the method as post. Next, we can obtain the values in the text boxes.       $_POST[' form_element_name '] will give you the value of the respective element. We can write the php code as follows (in the <head>) to obtain the value from Number 1 and Number 2 fields.       <?php              $num1=...
Post a Comment
Read more