API client testing in PyTest - Build an Automation Script

Verify GET /users API returns correct user data

Preconditions (2)

Step 1: Send a GET request to http://api.example.com/users/1

Step 2: Check the HTTP status code of the response

Step 3: Check the response body contains user data with ID 1 and name 'John Doe'

✅ Expected Result: Response status code is 200 and response body JSON contains {'id': 1, 'name': 'John Doe'}

Automation Requirements - pytest

Assertions Needed:

Assert response status code is 200

Assert response JSON contains correct user ID and name

Best Practices:

Use requests library for HTTP calls

Use pytest fixtures for setup if needed

Keep tests independent and repeatable

Use clear and descriptive assertion messages

Automated Solution

PyTest

import requests
import pytest

BASE_URL = "http://api.example.com"


def test_get_user_by_id():
    user_id = 1
    expected_name = "John Doe"
    response = requests.get(f"{BASE_URL}/users/{user_id}")
    
    # Assert status code is 200
    assert response.status_code == 200, f"Expected status code 200 but got {response.status_code}"
    
    data = response.json()
    
    # Assert user ID and name in response
    assert data.get('id') == user_id, f"Expected user id {user_id} but got {data.get('id')}"
    assert data.get('name') == expected_name, f"Expected user name '{expected_name}' but got '{data.get('name')}'"

This test sends a GET request to the API endpoint for user with ID 1.

We check the HTTP status code to confirm the request succeeded (200 means OK).

Then we parse the JSON response and verify the user ID and name match expected values.

Assertions include clear messages to help understand failures.

Using requests library is standard for HTTP calls in Python.

This test is simple, independent, and repeatable.

Common Mistakes - 3 Pitfalls

Not checking the HTTP status code before parsing JSON

Hardcoding full URLs multiple times

Not providing assertion messages

Bonus Challenge

Now add data-driven testing to verify multiple user IDs and names

Show Hint

Practice

1. What is the main purpose of API client testing in pytest?

easy

A. To verify that the code correctly communicates with the API

B. To check the user interface layout

C. To test database schema changes

D. To measure application performance speed

Solution

1. Step 1: Understand API client testing goal

   API client testing ensures the code sends requests and receives responses correctly from an API.

2. Step 2: Compare options with API client testing focus

   Only To verify that the code correctly communicates with the API relates to verifying communication with the API, others focus on unrelated areas.

3. Final Answer:

   To verify that the code correctly communicates with the API -> Option A

4. Quick Check:

   API client testing = verify API communication [OK]

Hint: API client testing checks API communication correctness [OK]

Common Mistakes:

• Confusing API testing with UI testing
• Thinking it tests database directly
• Mixing performance testing with API client testing

2. Which pytest code snippet correctly asserts that an API response status code is 200?

easy

A. assert response.statusCode == 200

B. assert response.status == 200

C. assert response.code == 200

D. assert response.status_code == 200

Solution

1. Step 1: Identify correct attribute for status code in response

   In most Python HTTP clients, the status code is accessed via response.status_code.

2. Step 2: Verify assertion syntax

   The assertion assert response.status_code == 200 is syntactically correct and checks the status code properly.

3. Final Answer:

   assert response.status_code == 200 -> Option D

4. Quick Check:

   Correct attribute is status_code [OK]

Hint: Use response.status_code to check HTTP status [OK]

Common Mistakes:

• Using incorrect attribute names like status or code
• Missing assert keyword
• Using camelCase instead of snake_case

3. Given the pytest test below, what will be the output if the API returns JSON {'success': true}?

def test_api_response(client):
    response = client.get('/status')
    data = response.json()
    assert data['success'] is True

medium

A. Test fails due to assertion error

B. Test fails due to KeyError

C. Test passes because 'success' is True

D. Test raises a syntax error

Solution

1. Step 1: Analyze the API response and JSON parsing

   The API returns JSON with key 'success' set to true, which maps to Python True after parsing.

2. Step 2: Check the assertion logic

   The assertion checks if data['success'] is True, which matches the parsed value, so it passes.

3. Final Answer:

   Test passes because 'success' is True -> Option C

4. Quick Check:

   JSON true = Python True, assertion passes [OK]

Hint: True in JSON becomes True in Python, assertion passes [OK]

Common Mistakes:

• Confusing JSON true with string 'true'
• Expecting KeyError when key exists
• Misreading assertion logic

4. Identify the error in this pytest API test code:

def test_get_user(client):
    response = client.get('/user/1')
    assert response.status_code = 200
    assert response.json()['id'] == 1

medium

A. Using single equals '=' instead of double '==' in assertion

B. Missing parentheses in response.json call

C. Incorrect endpoint URL format

D. No error, code is correct

Solution

1. Step 1: Check assertion syntax

   The line assert response.status_code = 200 uses single '=' which is assignment, not comparison.

2. Step 2: Confirm correct assertion operator

   Assertions require '==' to compare values, so it should be assert response.status_code == 200.

3. Final Answer:

   Using single equals '=' instead of double '==' in assertion -> Option A

4. Quick Check:

   Use '==' for comparison in assert [OK]

Hint: Use '==' in assert, not '=' [OK]

Common Mistakes:

• Confusing assignment '=' with comparison '=='
• Forgetting parentheses in method calls
• Assuming no syntax error in assert

5. You want to test an API client method that sends a POST request with JSON data and expects a 201 status code. Which pytest test code correctly performs this check?

hard

A. def test_create_item(client):
response = client.post('/items', data={'name': 'book'})
assert response.status_code == 201

B. def test_create_item(client):
response = client.post('/items', json={'name': 'book'})
assert response.status_code == 201

C. def test_create_item(client):
response = client.post('/items', json='name=book')
assert response.status_code == 201

D. def test_create_item(client):
response = client.post('/items', json={'name': 'book'})
assert response.status == 201

Solution

1. Step 1: Identify correct way to send JSON data in POST request

   Using json={'name': 'book'} sends JSON properly; data= sends form data, which is incorrect here.

2. Step 2: Verify correct status code assertion

   Use response.status_code == 201 to check for created resource status; response.status is invalid.

3. Final Answer:

   def test_create_item(client): response = client.post('/items', json={'name': 'book'}) assert response.status_code == 201 -> Option B

4. Quick Check:

   Use json= for JSON, assert status_code == 201 [OK]

Hint: Use json= dict and assert status_code == 201 [OK]

Common Mistakes:

• Using data= instead of json= for JSON payload
• Passing JSON as string instead of dict
• Using response.status instead of response.status_code