Why testing validates contracts in Rest API - Challenge Your Understanding

Challenge - 5 Problems

❓ Predict Output

intermediate

What is the output when the API returns unexpected data?

Consider a REST API client that expects a JSON response with a status field set to success. The client tests the response to validate the contract.

What will be the output of the following code if the API returns {"status": "error", "message": "Invalid request"}?

Rest API

response = {"status": "error", "message": "Invalid request"}
if response.get("status") == "success":
    print("Contract validated: success")
else:
    print("Contract violation detected")

A Contract violation detected

B Contract validated: success

C KeyError exception

D No output

💡 Hint

Check the value of the status key in the response dictionary.

The code checks if the status key equals success. Since the API returned error, the else branch runs, printing "Contract violation detected".

🧠 Conceptual

intermediate

Why is testing important for API contracts?

Which of the following best explains why testing validates API contracts?

A Testing guarantees the API will never have bugs.

B Testing improves the API server's hardware performance.

C Testing ensures the API implementation matches the agreed request and response formats.

D Testing replaces the need for documentation.

💡 Hint

Think about what a contract means in API communication.

API contracts define how clients and servers communicate. Testing checks that the API behaves as promised, matching the contract's request and response formats.

🔧 Debug

advanced

Identify the error in this API contract test

The following test checks if the API response contains a data field with a list. What error will this code produce if the API returns {"data": null}?

Rest API

response = {"data": None}
if isinstance(response["data"], list):
    print("Valid data list")
else:
    print("Invalid data format")

A Invalid data format

B KeyError exception

C Valid data list

D TypeError exception

💡 Hint

Check the type of response["data"] when it is None.

The code checks if response["data"] is a list. Since it is None, the else branch runs, printing "Invalid data format". No exception occurs.

📝 Syntax

advanced

Which option causes a syntax error in this API test code?

Which of the following code snippets will cause a syntax error when testing an API response?

A if 'status' in response: print('OK')

B if response.get('status') == 'success': print('OK')

C if response.get('status') != 'error': print('OK')

D if response['status'] = 'success': print('OK')

💡 Hint

Look for the assignment operator used inside the if condition.

Option D uses = (assignment) instead of == (comparison) inside the if condition, causing a syntax error.

🚀 Application

expert

How many contract violations are detected in this batch test?

Given the following list of API responses, how many violate the contract that requires status to be success?

responses = [
  {"status": "success", "data": [1,2]},
  {"status": "error", "message": "fail"},
  {"status": "success", "data": []},
  {"status": "pending"}
]

Rest API

responses = [
  {"status": "success", "data": [1,2]},
  {"status": "error", "message": "fail"},
  {"status": "success", "data": []},
  {"status": "pending"}
]
violations = 0
for r in responses:
    if r.get("status") != "success":
        violations += 1
print(violations)

A 1

B 2

C 3

D 4

💡 Hint

Count how many responses have a status not equal to success.

Two responses have status values other than success: "error" and "pending". So, violations = 2.

Practice

1. Why is testing important for validating REST API contracts?

easy

A. It makes the API run faster by optimizing code.

B. It automatically generates API documentation.

C. It ensures the API follows agreed rules and behaves as expected.

D. It replaces the need for API design.

Solution

1. Step 1: Understand the purpose of API contracts

   API contracts define rules about how APIs should behave and what data they exchange.

2. Step 2: Role of testing in contracts

   Testing checks if the API follows these rules and returns expected results, catching mistakes early.

3. Final Answer:

   It ensures the API follows agreed rules and behaves as expected. -> Option C

4. Quick Check:

   Testing validates contracts = Ensures API rules followed [OK]

Hint: Testing checks if API follows rules and returns expected data [OK]

Common Mistakes:

• Thinking testing speeds up API automatically
• Confusing testing with documentation generation
• Believing testing replaces API design

2. Which of the following is the correct way to test a REST API contract for a GET request?

easy

A. Send a DELETE request and expect a 500 error.

B. Send a POST request and check if the response status is 404.

C. Send a GET request and ignore the response content.

D. Send a GET request and check if the response status is 200 and data format matches the contract.

Solution

1. Step 1: Identify correct HTTP method and expected response

   For a GET request, the API should return status 200 and data matching the contract.

2. Step 2: Match testing action to contract validation

   Sending GET and checking status 200 plus data format confirms contract adherence.

3. Final Answer:

   Send a GET request and check if the response status is 200 and data format matches the contract. -> Option D

4. Quick Check:

   GET test checks status 200 and data format [OK]

Hint: Test GET by checking status 200 and correct data format [OK]

Common Mistakes:

• Using wrong HTTP method for the test
• Ignoring response content in tests
• Expecting error codes for successful GET

3. Given this test code snippet for a REST API endpoint:

response = client.get('/users/123')
assert response.status_code == 200
assert 'id' in response.json()
assert response.json()['id'] == 123

What does this test validate about the API contract?

medium

A. The API returns status 200 and correct user id in JSON response.

B. The API returns status 404 for missing users.

C. The API accepts POST requests at /users/123.

D. The API returns an empty JSON response.

Solution

1. Step 1: Analyze the test assertions

   The test checks that the response status code is 200 and the JSON response contains an 'id' key equal to 123.

2. Step 2: Understand what this means for the API contract

   This confirms the API returns successful status and correct user data as per contract.

3. Final Answer:

   The API returns status 200 and correct user id in JSON response. -> Option A

4. Quick Check:

   Test checks status 200 and user id = 123 [OK]

Hint: Check status and key-value in JSON to validate contract [OK]

Common Mistakes:

• Confusing status 404 with 200
• Assuming POST method is tested here
• Ignoring JSON content checks

4. A test for a REST API endpoint expects a JSON response with a 'name' field. The test code is:

response = client.get('/items/5')
assert response.status_code == 200
assert 'name' in response.json()

But the test fails with a KeyError. What is the likely cause?

medium

A. The response status code is not 200.

B. The API response JSON does not include the 'name' field as per contract.

C. The test used the wrong HTTP method.

D. The client.get() method is not defined.

Solution

1. Step 1: Understand the test failure

   A KeyError means the 'name' key is missing in the JSON response.

2. Step 2: Identify contract violation

   The API response does not include the expected 'name' field, violating the contract.

3. Final Answer:

   The API response JSON does not include the 'name' field as per contract. -> Option B

4. Quick Check:

   Missing 'name' key causes KeyError [OK]

Hint: KeyError means expected JSON key missing in response [OK]

Common Mistakes:

• Assuming wrong HTTP method caused error
• Ignoring status code correctness
• Blaming client.get() method existence

5. You have a REST API contract that requires the endpoint /orders/{id} to return a JSON with fields id, status, and items (a list). Which test best validates this contract?

hard

A. Send GET /orders/10, check status 200, verify JSON has 'id', 'status', and 'items' keys, and 'items' is a list.

B. Send POST /orders with empty body and expect status 201.

C. Send GET /orders/10 and check only the status code is 404.

D. Send DELETE /orders/10 and expect status 500.

Solution

1. Step 1: Identify contract requirements

   The contract requires GET /orders/{id} to return JSON with 'id', 'status', and 'items' keys, where 'items' is a list.

2. Step 2: Match test to contract validation

   Sending GET /orders/10, checking status 200, verifying JSON has 'id', 'status', and 'items' keys, and confirming 'items' is a list fully validates the contract.

3. Final Answer:

   Send GET /orders/10, check status 200, verify JSON has 'id', 'status', and 'items' keys, and 'items' is a list. -> Option A

4. Quick Check:

   Test checks all required fields and types [OK]

Hint: Check all required fields and data types in JSON response [OK]

Common Mistakes:

• Testing wrong HTTP method
• Ignoring required JSON fields
• Not verifying data types like list