Why REST principles matter in Express - Performance Evidence

Performance: Why REST principles matter

MEDIUM IMPACT

This affects how quickly and efficiently a web API responds to requests, impacting server response time and client rendering speed.

Designing an API endpoint for fetching user data

Express

app.get('/users/1', (req, res) => {
  // returns only necessary user info following REST resource URL
  res.json({ id: 1, name: 'Alice' });
});

Uses clear resource URL and returns minimal necessary data, reducing payload and speeding response.

📈 Performance GainReduces payload size by 30-50%, improves response time and client rendering speed.

Designing an API endpoint for fetching user data

Express

app.get('/getUserData', (req, res) => {
  // returns all user data including unnecessary nested info
  res.json({ user: { id: 1, name: 'Alice', password: 'secret', settings: { theme: 'dark', notifications: true } } });
});

Returns excessive data and uses non-resource-oriented URL, causing larger payloads and slower client rendering.

📉 Performance CostIncreases payload size by 30-50%, slows response time, and delays client rendering.

Performance Comparison

Pattern	Payload Size	Server Processing	Caching	Verdict
Non-RESTful API (large payload, unclear URLs)	High	High	No	[X] Bad
RESTful API (minimal payload, clear URLs)	Low	Low	Yes	[OK] Good

Rendering Pipeline

REST principles influence how quickly the server can process requests and send responses, which affects the browser's ability to start rendering content.

→Network Request

→Server Processing

→Response Parsing

→Rendering

⚠️ BottleneckServer Processing and Network Request due to inefficient API design

Core Web Vital Affected

INP

This affects how quickly and efficiently a web API responds to requests, impacting server response time and client rendering speed.

Optimization Tips

1Use clear, resource-oriented URLs to improve caching and routing.

2Return only necessary data to reduce payload size and speed up responses.

3Use correct HTTP methods to enable browser caching and efficient server processing.

Performance Quiz - 3 Questions

Which REST principle helps reduce server processing time and speeds up client rendering?

A Using clear resource URLs and minimal payloads

B Using POST for all requests regardless of action

C Returning all user data including sensitive info

D Ignoring HTTP status codes

DevTools: Network

How to check: Open DevTools, go to Network tab, reload the API request, and inspect the request URL, method, and response size.

What to look for: Look for clear resource URLs, correct HTTP methods (GET, PUT, POST, DELETE), and small response payload sizes for better performance.

Practice

1. Why is it important to follow REST principles when building an Express API?

easy

A. It requires using XML instead of JSON for data exchange.

B. It forces the use of only POST requests for all actions.

C. It makes the API easier to understand and use by clients.

D. It limits the API to only one endpoint for all resources.

Solution

1. Step 1: Understand REST principles

   REST encourages clear use of HTTP methods and resource URLs to make APIs intuitive.

2. Step 2: Connect REST to client ease

   Following REST helps clients know how to interact with the API without confusion.

3. Final Answer:

   It makes the API easier to understand and use by clients. -> Option C

4. Quick Check:

   REST improves API clarity = A [OK]

Hint: REST means clear, simple API design for clients [OK]

Common Mistakes:

• Thinking REST requires only POST requests
• Believing REST forces XML data format
• Assuming REST limits to one endpoint

2. Which HTTP method should you use in Express to retrieve data from a resource following REST principles?

easy

A. GET

B. PUT

C. DELETE

D. POST

Solution

1. Step 1: Recall HTTP methods in REST

   GET is used to retrieve or read data without changing it.

2. Step 2: Match method to action

   Since retrieving data means reading, GET is the correct method.

3. Final Answer:

   GET -> Option A

4. Quick Check:

   Retrieve data = GET [OK]

Hint: GET is for reading data, POST for creating [OK]

Common Mistakes:

• Using POST to fetch data
• Confusing DELETE with data retrieval
• Using PUT instead of GET for reading

3. Consider this Express route following REST principles:

app.delete('/users/:id', (req, res) => {
  // delete user logic
  res.send('User deleted');
});

What HTTP method and URL would a client use to delete user with id 5?

medium

A. DELETE /users/5

B. POST /users/5

C. GET /users/5

D. PUT /users/5

Solution

1. Step 1: Identify the route method and path

   The route uses app.delete with path '/users/:id', so it expects DELETE requests to /users/{id}.

2. Step 2: Match method and URL for deleting user 5

   To delete user 5, client sends DELETE request to /users/5.

3. Final Answer:

   DELETE /users/5 -> Option A

4. Quick Check:

   Delete user = DELETE /users/5 [OK]

Hint: Delete uses DELETE method with resource URL [OK]

Common Mistakes:

• Using GET or POST to delete
• Confusing PUT with DELETE
• Using wrong URL path

4. You wrote this Express route to update a user:

app.post('/users/:id', (req, res) => {
  // update user logic
  res.send('User updated');
});

Why might this not follow REST principles correctly?

medium

A. The URL should not include the user id.

B. POST should not be used for updating existing resources.

C. The response message is incorrect.

D. The route should use GET instead of POST.

Solution

1. Step 1: Understand REST method usage

   POST is usually for creating new resources, while PUT or PATCH is for updating existing ones.

2. Step 2: Identify correct method for update

   Updating user should use PUT or PATCH, not POST, to follow REST.

3. Final Answer:

   POST should not be used for updating existing resources. -> Option B

4. Quick Check:

   Update uses PUT/PATCH, not POST [OK]

Hint: Use PUT/PATCH to update, not POST [OK]

Common Mistakes:

• Thinking POST is for updates
• Ignoring URL with resource id
• Confusing GET with update

5. You want to design an Express API that follows REST principles for managing books. Which of these URL and method combinations correctly follows REST for updating a book's details?

hard

A. DELETE /books/:id

B. POST /books/update

C. GET /books/:id/update

D. PUT /books/:id

Solution

1. Step 1: Identify REST method for updating

   PUT is the standard HTTP method to update an existing resource fully.

2. Step 2: Check URL pattern for resource

   Using /books/:id targets a specific book by its id, which is correct REST style.

3. Step 3: Evaluate other options

   POST /books/update is not RESTful because it uses a verb in URL; GET is for reading, DELETE is for removal.

4. Final Answer:

   PUT /books/:id -> Option D

5. Quick Check:

   Update book = PUT /books/:id [OK]

Hint: Update uses PUT with resource ID in URL [OK]

Common Mistakes:

• Using POST with action verbs in URL
• Using GET for updates
• Confusing DELETE with update