HATEOAS concept overview in Express - Step-by-Step Execution

Concept Flow - HATEOAS concept overview

Client sends request

↓

Server processes request

↓

Server sends response with data + links

↓

Client reads data

↓

Client follows links for next actions

↓

Repeat as needed

This flow shows how a client requests data, the server responds with data plus helpful links, and the client uses those links to navigate the API.

Execution Sample

Express

app.get('/books/:id', (req, res) => {
  res.json({
    id: req.params.id,
    title: 'Example Book',
    links: [{ rel: 'author', href: '/authors/123' }]
  });
});

This Express route sends book data with a link to the author resource, showing HATEOAS in action.

Execution Table

Step	Action	Request URL	Response Data	Links Included
1	Client requests book with id 1	/books/1	N/A	N/A
2	Server receives request	/books/1	N/A	N/A
3	Server prepares response	/books/1	{ id: '1', title: 'Example Book' }	[{ rel: 'author', href: '/authors/123' }]
4	Server sends response	/books/1	{ id: '1', title: 'Example Book', links: [...] }	Yes
5	Client receives response	/books/1	{ id: '1', title: 'Example Book', links: [...] }	Yes
6	Client uses link to get author	/authors/123	N/A	N/A

💡 Client uses links in response to navigate API without hardcoding URLs.

Variable Tracker

Variable	Start	After Step 3	After Step 4	Final
req.params.id	undefined	1	1	1
response data	empty	{ id: '1', title: 'Example Book' }	{ id: '1', title: 'Example Book', links: [...] }	{ id: '1', title: 'Example Book', links: [...] }

Key Moments - 2 Insights

Why does the server send links along with data?

The server includes links so the client knows what actions or related data are available next, as shown in step 3 and 4 of the execution_table.

Does the client need to know all URLs beforehand?

No, the client discovers URLs dynamically from the links in the server response, avoiding hardcoded paths (see step 6).

Visual Quiz - 3 Questions

Look at the execution_table, what does the server include in the response at step 4?

A Only raw data without links

B Data plus links to related resources

C Only links without data

D An error message

💡 Hint

Check the 'Response Data' and 'Links Included' columns at step 4.

At which step does the client use the link to get the author information?

A Step 2

B Step 4

C Step 6

D Step 1

💡 Hint

Look at the 'Action' column describing client behavior after receiving links.

If the server did not include links in the response, what would change in the execution_table?

A The 'Links Included' column would be empty or 'No' at step 4

B The client would still use links at step 6

C The server would send an error at step 4

D The client would request the author at step 2

💡 Hint

Consider how the presence of links affects client navigation in the table.

Concept Snapshot

HATEOAS means the server sends data plus links to related actions.
Clients use these links to navigate the API dynamically.
This avoids hardcoding URLs in the client.
In Express, include a 'links' array in JSON responses.
Clients read links to know what to do next.

Full Transcript

HATEOAS stands for Hypermedia As The Engine Of Application State. It means when a client asks the server for data, the server replies with the data plus links to related resources or actions. This way, the client can discover what to do next by following these links instead of guessing URLs. In Express, you can add a 'links' array in your JSON response to show these related URLs. The client reads these links and uses them to navigate the API smoothly. This approach makes APIs easier to use and more flexible.

Practice

1. What is the main purpose of HATEOAS in an Express API?

easy

A. To encrypt API data for security

B. To speed up the server response time

C. To include links in responses that guide clients on possible next actions

D. To reduce the size of JSON responses

Solution

1. Step 1: Understand HATEOAS concept

   HATEOAS stands for Hypermedia As The Engine Of Application State, which means APIs provide links to guide clients on what to do next.

2. Step 2: Identify main purpose in Express API

   Express apps use HATEOAS by sending links in JSON responses to help clients discover available actions without extra docs.

3. Final Answer:

   To include links in responses that guide clients on possible next actions -> Option C

4. Quick Check:

   HATEOAS guides clients with links = C [OK]

Hint: HATEOAS means adding helpful links in API responses [OK]

Common Mistakes:

• Thinking HATEOAS speeds up server
• Confusing HATEOAS with encryption
• Believing it reduces JSON size

2. Which of the following is the correct way to include a HATEOAS link in an Express JSON response?

easy

A. res.json({ data: user, links: [{ rel: 'self', href: '/users/1' }] });

B. res.send('User');

C. res.json({ data: user, url: '/users/1' });

D. res.render('user', { link: '/users/1' });

Solution

1. Step 1: Identify JSON response with HATEOAS links

   HATEOAS links are included as part of JSON, usually in a 'links' array with 'rel' and 'href' keys.

2. Step 2: Check Express syntax for sending JSON

   res.json() sends JSON data; res.json({ data: user, links: [{ rel: 'self', href: '/users/1' }] }); correctly uses 'links' array with proper structure.

3. Final Answer:

   res.json({ data: user, links: [{ rel: 'self', href: '/users/1' }] }); -> Option A

4. Quick Check:

   HATEOAS links in JSON with rel/href = A [OK]

Hint: HATEOAS links go inside JSON under 'links' key [OK]

Common Mistakes:

• Sending HTML instead of JSON
• Using 'url' instead of 'links' array
• Rendering views instead of JSON

3. Given this Express route code, what will the JSON response include?

app.get('/books/:id', (req, res) => {
  const book = { id: req.params.id, title: 'Learn Express' };
  res.json({
    data: book,
    links: [
      { rel: 'self', href: `/books/${book.id}` },
      { rel: 'author', href: `/authors/123` }
    ]
  });
});

medium

A. Error because template literals are not allowed

B. Only book data without any links

C. HTML page showing book title

D. JSON with book data and two links: self and author

Solution

1. Step 1: Analyze the route handler

   The route sends JSON with 'data' containing book info and 'links' array with two link objects.

2. Step 2: Confirm template literals usage

   Template literals are valid in modern JavaScript, so href values will be correct URLs.

3. Final Answer:

   JSON with book data and two links: self and author -> Option D

4. Quick Check:

   Response includes data and links array = A [OK]

Hint: Look for 'links' array in JSON response to find HATEOAS links [OK]

Common Mistakes:

• Assuming no links are sent
• Confusing JSON with HTML output
• Thinking template literals cause errors

4. What is wrong with this Express code snippet trying to implement HATEOAS?

app.get('/items/:id', (req, res) => {
  const item = { id: req.params.id, name: 'Item A' };
  res.json({
    data: item,
    links: {
      rel: 'self',
      href: `/items/${item.id}`
    }
  });
});

medium

A. Missing status code in response

B. The 'links' property should be an array, not an object

C. res.json should be replaced with res.send

D. Template literals cannot be used inside JSON

Solution

1. Step 1: Check 'links' structure for HATEOAS

   HATEOAS expects 'links' to be an array of link objects, not a single object.

2. Step 2: Validate other code parts

   Template literals are valid, res.json is correct, and status code defaults to 200, so no issues there.

3. Final Answer:

   The 'links' property should be an array, not an object -> Option B

4. Quick Check:

   'links' must be array for multiple links = D [OK]

Hint: 'links' must be an array of objects, not a single object [OK]

Common Mistakes:

• Using object instead of array for 'links'
• Thinking template literals are invalid
• Replacing res.json with res.send unnecessarily

5. You want to design an Express API that uses HATEOAS to help clients navigate a blog. Which approach best applies HATEOAS principles?

hard

A. Include in each blog post response links to 'self', 'author', and 'comments' endpoints

B. Send only blog post data without any links to keep response small

C. Provide a separate documentation page listing all API URLs

D. Use query parameters to list all possible next URLs

Solution

1. Step 1: Recall HATEOAS goal

   HATEOAS guides clients by embedding links in responses to related resources or actions.

2. Step 2: Evaluate options for blog API

   Include in each blog post response links to 'self', 'author', and 'comments' endpoints includes links to related endpoints in each response, matching HATEOAS principles. Options A, C, and D do not embed navigational links in responses.

3. Final Answer:

   Include in each blog post response links to 'self', 'author', and 'comments' endpoints -> Option A

4. Quick Check:

   Embed navigational links in response = B [OK]

Hint: Embed related resource links inside each response for HATEOAS [OK]

Common Mistakes:

• Skipping links to keep response small
• Relying only on external docs
• Using query params instead of links