Why consistent formats improve usability in Rest API - Challenge Your Understanding

Challenge - 5 Problems

🧠 Conceptual

intermediate

Why use consistent response formats in REST APIs?

Imagine you are building a REST API that many developers will use. Why is it important to keep the response format consistent across all endpoints?

A It helps developers understand and use the API faster because they expect the same structure everywhere.

B It allows each endpoint to return data in any random format to keep things flexible.

C It makes the API slower because it has to check the format every time.

D It forces developers to write more code to handle different formats.

💡 Hint

Think about how you feel when you use tools that behave the same way every time.

Consistent formats reduce confusion and errors. Developers can reuse code and understand responses quickly, improving usability.

❓ Predict Output

intermediate

What is the output of this JSON response?

Given this API response format, what will be the value of data['user']['name']?

Rest API

response = {
  "status": "success",
  "data": {
    "user": {
      "id": 101,
      "name": "Alice",
      "email": "[e-mail]"
    }
  }
}

print(response['data']['user']['name'])

A "[e-mail]"

B "Alice"

C 101

D KeyError

💡 Hint

Look carefully at the nested keys to find the name.

The key data contains user, which has a name key with value "Alice".

🔧 Debug

advanced

Identify the error in this inconsistent API response

This API sometimes returns a list and sometimes a dictionary for the same endpoint. What error will this cause in client code expecting a consistent format?

Rest API

response1 = {"items": [{"id": 1}, {"id": 2}]}
response2 = {"items": {"id": 1}}

# Client code expects a list:
for item in response1['items']:
    print(item['id'])

for item in response2['items']:
    print(item['id'])

A TypeError because 'int' object is not iterable in the second loop

B KeyError because 'id' does not exist

C No error, both loops run fine

D SyntaxError due to missing colon

💡 Hint

Check the type of response2['items'] and how the loop treats it.

The second response returns a dictionary instead of a list, so the for-loop tries to iterate over a dict, causing a TypeError.

📝 Syntax

advanced

Which option shows a valid consistent JSON error response format?

Choose the option that correctly represents a consistent JSON error response with a message and code.

A {"error": {"code" => 404, "message" => "Not Found"}}

B {"error": ["code": 404, "message": "Not Found"]}

C {"error": {code: 404, message: "Not Found"}}

D {"error": {"code": 404, "message": "Not Found"}}

💡 Hint

Remember JSON keys and string values must be in double quotes and use colons.

Option D uses correct JSON syntax with keys and string values in double quotes and colons separating keys and values.

🚀 Application

expert

How many items are in the combined consistent API response?

You receive two paginated API responses with consistent formats. How many total items are there combined?

Rest API

response_page1 = {"status": "success", "data": {"items": [1, 2, 3], "page": 1}}
response_page2 = {"status": "success", "data": {"items": [4, 5], "page": 2}}

combined_items = response_page1['data']['items'] + response_page2['data']['items']

print(len(combined_items))

A 2

B 3

C 5

D TypeError

💡 Hint

Count the total number of items in both lists combined.

Both pages have lists of items. Adding them combines all items into one list of length 5.