Why REST APIs exist - Challenge Your Understanding

Challenge - 5 Problems

🧠 Conceptual

intermediate

Purpose of REST APIs

Why do REST APIs exist in software development?

A To store large amounts of data locally on a user's device

B To compile source code into machine code

C To create graphical user interfaces for desktop applications

D To allow different software systems to communicate over the internet using a standard set of rules

💡 Hint

Think about how apps and websites talk to each other over the internet.

REST APIs exist to enable different software systems to communicate with each other over the internet using a common set of rules. This makes it easier to build and connect applications.

❓ Predict Output

intermediate

Output of a REST API call simulation

What is the output of this simulated REST API call in Python?

Rest API

def get_user():
    return {'id': 1, 'name': 'Alice'}

response = get_user()
print(response['name'])

A Alice

B 1

C {'id': 1, 'name': 'Alice'}

D KeyError

💡 Hint

Look at what key is accessed in the dictionary.

The function returns a dictionary with keys 'id' and 'name'. The code prints the value for the key 'name', which is 'Alice'.

🔧 Debug

advanced

Identify the error in REST API response handling

What error will this code produce when handling a REST API response?

Rest API

response = {'status': 404, 'message': 'Not Found'}
print(response['data'])

A ValueError

B TypeError

C KeyError

D No error, prints None

💡 Hint

Check if the key 'data' exists in the dictionary.

The dictionary does not have a key named 'data', so trying to access it causes a KeyError.

📝 Syntax

advanced

Syntax error in REST API request code

Which option contains a syntax error in this Python REST API request snippet?

Rest API

import requests
response = requests.get('https://api.example.com/data')
print(response.json())

A

import requests
response = requests.get('https://api.example.com/data')
print(response.json())

B

import requests
response = requests.get('https://api.example.com/data'
print(response.json())

C

import requests
response = requests.get('https://api.example.com/data')
print(response.json)

D

))(nosj.esnopser(tnirp
)'atad/moc.elpmaxe.ipa//:sptth'(teg.stseuqer = esnopser
stseuqer tropmi

💡 Hint

Look for missing or extra parentheses.

Option B is missing a closing parenthesis on the get() call, causing a SyntaxError.

🚀 Application

expert

Number of items in REST API JSON response

Given this JSON response from a REST API, how many user objects does it contain?

Rest API

response = {
  "users": [
    {"id": 1, "name": "Alice"},
    {"id": 2, "name": "Bob"},
    {"id": 3, "name": "Charlie"}
  ]
}

count = len(response['users'])
print(count)

A 3

B 1

C 2

D 0

💡 Hint

Count the number of dictionaries inside the 'users' list.

The 'users' key holds a list of 3 user dictionaries, so the count is 3.

Practice

1. Why do REST APIs exist in software development?

easy

A. To allow different programs to communicate over the internet using simple rules

B. To create complex user interfaces for websites

C. To store data only on local machines

D. To replace all programming languages with one standard

Solution

1. Step 1: Understand the purpose of REST APIs

   REST APIs are designed to let different software programs talk to each other over the internet easily.

2. Step 2: Compare options with this purpose

   Only To allow different programs to communicate over the internet using simple rules correctly describes this purpose. Options A, B, and C do not relate to REST APIs' main goal.

3. Final Answer:

   To allow different programs to communicate over the internet using simple rules -> Option A

4. Quick Check:

   REST APIs exist for communication = D [OK]

Hint: REST APIs help programs talk over the internet simply [OK]

Common Mistakes:

• Thinking REST APIs create user interfaces
• Believing REST APIs store data locally only
• Assuming REST APIs replace programming languages

2. Which HTTP method is commonly used in REST APIs to retrieve data from a server?

easy

A. GET

B. POST

C. DELETE

D. PUT

Solution

1. Step 1: Recall HTTP methods in REST APIs

   GET is the method used to request and retrieve data from a server.

2. Step 2: Match the method to the action

   POST sends data, DELETE removes data, PUT updates data. Only GET retrieves data.

3. Final Answer:

   GET -> Option A

4. Quick Check:

   Retrieve data = GET [OK]

Hint: GET means get data from server in REST APIs [OK]

Common Mistakes:

• Confusing POST with GET for data retrieval
• Using DELETE or PUT to get data
• Not knowing HTTP method purposes

3. What will be the output of this REST API call?

GET /users/123

Assuming user 123 exists and the API returns JSON data.

medium

A. 500 Internal Server Error

B. {"id":123,"name":"Alice"}

C. 404 Not Found

D. {"error":"User not found"}

Solution

1. Step 1: Understand the GET request to /users/123

   This request asks the server for data about user with ID 123.

2. Step 2: Check the condition given

   The user 123 exists, so the server returns the user's data in JSON format.

3. Final Answer:

   {"id":123,"name":"Alice"} -> Option B

4. Quick Check:

   Existing user GET returns data = C [OK]

Hint: GET existing user returns JSON data, not error [OK]

Common Mistakes:

• Choosing error responses when user exists
• Confusing 404 with successful data return
• Not recognizing JSON format

4. Identify the error in this REST API usage:

POST /users/123

What is wrong if the goal is to update user 123's data?

medium

A. The URL should not include the user ID

B. GET method should be used to update data

C. POST is used instead of PUT for updating existing data

D. DELETE method is required to update data

Solution

1. Step 1: Understand HTTP methods for REST APIs

   POST is usually for creating new data, PUT is for updating existing data.

2. Step 2: Match method to action

   Since the goal is to update user 123, PUT should be used instead of POST.

3. Final Answer:

   POST is used instead of PUT for updating existing data -> Option C

4. Quick Check:

   Update needs PUT, not POST = B [OK]

Hint: Use PUT to update existing data, not POST [OK]

Common Mistakes:

• Using POST to update instead of PUT
• Thinking GET updates data
• Believing DELETE updates data

5. You want to design a REST API that allows clients to list all products and add new products. Which HTTP methods and URLs should you use?

hard

A. DELETE /products to list, PUT /products to add new

B. POST /products to list, GET /products to add new

C. PUT /products to list, DELETE /products to add new

D. GET /products to list, POST /products to add new

Solution

1. Step 1: Identify methods for listing and adding

   GET is used to retrieve or list data, POST is used to create or add new data.

2. Step 2: Match methods with URLs

   Both actions use the /products URL; GET lists products, POST adds new products.

3. Final Answer:

   GET /products to list, POST /products to add new -> Option D

4. Quick Check:

   List = GET, Add = POST = A [OK]

Hint: GET lists, POST adds new resources in REST APIs [OK]

Common Mistakes:

• Swapping GET and POST roles
• Using DELETE or PUT incorrectly
• Confusing URLs for different actions