API test automation concepts in Testing Fundamentals - Full Explanation

Introduction

Testing an API manually can be slow and error-prone, especially when changes happen often. Automating API tests helps catch problems quickly and keeps software reliable without repeating boring tasks.

Explanation

What is API Testing

API testing checks if the communication between software parts works correctly. It focuses on sending requests to the API and verifying the responses match expectations, without using the user interface.

API testing ensures that software parts talk to each other correctly through their interfaces.

Why Automate API Tests

Automating API tests saves time by running many tests quickly and often. It helps find bugs early, supports continuous development, and reduces human mistakes compared to manual testing.

Automation makes API testing faster, more reliable, and easier to repeat.

Common API Test Types

Tests include checking if the API returns correct data (functional), handles errors well (negative), performs fast enough (performance), and keeps data secure (security). Each type focuses on different quality aspects.

Different test types check various API qualities like correctness, speed, and safety.

Test Automation Tools

Tools like Postman, REST Assured, and SoapUI help create and run automated API tests. They provide ways to send requests, check responses, and organize tests in scripts or collections.

Automation tools simplify writing and running API tests efficiently.

Best Practices for API Test Automation

Good practices include writing clear test cases, isolating tests to avoid dependencies, using realistic data, and integrating tests into the development process for continuous feedback.

Following best practices makes API test automation effective and maintainable.

Real World Analogy

Imagine a restaurant kitchen where chefs (software parts) pass dishes (data) through a window (API). Testing the window means checking if orders come through correctly and dishes are passed without mistakes. Automating this check is like having a smart camera that watches the window and alerts if something goes wrong.

What is API Testing → Checking if the kitchen window correctly passes orders and dishes between chefs.

Why Automate API Tests → Using a smart camera to watch the window continuously instead of a person checking every time.

Common API Test Types → Making sure orders are correct, dishes are not dropped, the window opens quickly, and no one steals food.

Test Automation Tools → The smart camera and software that automatically monitor and report issues at the kitchen window.

Best Practices for API Test Automation → Setting up the camera properly, focusing on important spots, and regularly reviewing footage to keep the kitchen running smoothly.

Diagram

Diagram

┌─────────────────────────────┐
│        API Test Automation  │
├─────────────┬───────────────┤
│  Test Types │   Tools       │
│ ┌─────────┐ │ ┌───────────┐ │
│ │Functional│ │ │ Postman   │ │
│ │Negative  │ │ │ REST Assured││
│ │Performance││ │ SoapUI    │ │
│ │Security  │ │ └───────────┘ │
│ └─────────┘ │               │
├─────────────┴───────────────┤
│      Best Practices         │
│ - Clear cases              │
│ - Isolated tests           │
│ - Realistic data           │
│ - Continuous integration   │
└─────────────────────────────┘

This diagram shows the main parts of API test automation: test types, tools, and best practices working together.

Key Facts

API Testing → Verifies that software components communicate correctly through their interfaces.

Test Automation → Using software tools to run tests automatically without manual effort.

Functional Testing → Checks if the API returns the correct data for valid requests.

Negative Testing → Ensures the API handles invalid inputs or errors gracefully.

Performance Testing → Measures how fast and responsive the API is under load.

Security Testing → Verifies that the API protects data and prevents unauthorized access.

Code Example

Testing Fundamentals

import requests

def test_get_user():
    url = 'https://jsonplaceholder.typicode.com/users/1'
    response = requests.get(url)
    assert response.status_code == 200
    data = response.json()
    assert data['id'] == 1
    assert 'username' in data

if __name__ == '__main__':
    test_get_user()
    print('API test passed')

Common Confusions

API testing is the same as UI testing.

API testing is the same as UI testing. API testing focuses on backend communication without using the user interface, while UI testing checks the visible parts users interact with.

Automated tests replace the need for manual testing completely.

Automated tests replace the need for manual testing completely. Automation speeds up testing but manual tests are still important for exploratory and usability checks.

All API tests must be functional tests.

All API tests must be functional tests. API testing includes functional, negative, performance, and security tests to cover different quality aspects.

Summary

API test automation helps check software communication quickly and reliably without manual effort.

Different test types like functional, negative, performance, and security cover all important API qualities.

Using tools and best practices makes automated API testing easier to maintain and integrate into development.

Practice

1. What is the main purpose of API test automation?

easy

A. To design the user interface of an application

B. To check if different software parts communicate correctly

C. To write code for the backend server

D. To create database schemas

Solution

1. Step 1: Understand API test automation goal

   API test automation focuses on verifying communication between software parts via APIs.

2. Step 2: Eliminate unrelated options

   Designing UI, writing backend code, and creating database schemas are not related to API test automation.

3. Final Answer:

   To check if different software parts communicate correctly -> Option B

4. Quick Check:

   API test automation = communication check [OK]

Hint: API tests check communication, not UI or database [OK]

Common Mistakes:

• Confusing API testing with UI testing
• Thinking API tests create backend code
• Mixing API testing with database design

2. Which of the following is the correct way to check the HTTP status code in an automated API test using Python's requests library?

easy

A. response.code == 200

B. response.status == 200

C. response.status_code == 200

D. response.statusCode == 200

Solution

1. Step 1: Recall Python requests response attribute

   The correct attribute to get HTTP status code is status_code.

2. Step 2: Match options with correct attribute

   Only response.status_code == 200 uses the correct attribute and syntax.

3. Final Answer:

   response.status_code == 200 -> Option C

4. Quick Check:

   requests status code = status_code [OK]

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

Common Mistakes:

• Using incorrect attribute names like status or code
• Confusing camelCase with snake_case
• Forgetting double equals for comparison

3. Given this Python code snippet for an API test:

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

What will be the output if the API response JSON is {"status": "success", "data": []}?

medium

A. "success"

B. KeyError

C. {'status': 'success'}

D. success

Solution

1. Step 1: Understand response.json() output

   response.json() returns a Python dictionary parsed from JSON.

2. Step 2: Access the 'status' key value

   Accessing ['status'] returns the string "success" without quotes in print output.

3. Final Answer:

   success -> Option D

4. Quick Check:

   Print dict value = string without quotes [OK]

Hint: Print of string value shows without quotes in Python [OK]

Common Mistakes:

• Expecting quotes around printed string
• Confusing JSON string with Python print output
• Assuming KeyError without checking keys

4. You wrote this API test code snippet:

response = requests.post('https://api.example.com/login', data={'user': 'admin', 'pass': '1234'})
assert response.status_code = 200

What is the error and how to fix it?

medium

A. Use '==' for comparison in assert, not '='

B. Change 'data' to 'json' in requests.post() call

C. Use 'response.status' instead of 'response.status_code'

D. Add parentheses around assert condition

Solution

1. Step 1: Identify syntax error in assert statement

   The assert statement uses '=' which is assignment, not comparison.

2. Step 2: Correct assert syntax

   Replace '=' with '==' to compare response.status_code to 200.

3. Final Answer:

   Use '==' for comparison in assert, not '=' -> Option A

4. Quick Check:

   Assert needs '==' for comparison [OK]

Hint: Assert uses '==' to compare, '=' assigns [OK]

Common Mistakes:

• Using '=' instead of '==' in assert
• Confusing 'data' and 'json' parameters (not error here)
• Using wrong attribute like response.status

5. You want to automate testing an API that returns a list of users with their ages. You need to verify the API only returns users aged 18 or older. Which approach best fits this requirement?

hard

A. Send a GET request, parse JSON response, then assert all ages >= 18

B. Send a POST request with age filter, then check status code 200

C. Check only the first user's age in the response

D. Verify the response content type is 'text/html'

Solution

1. Step 1: Understand requirement to verify all users' ages

   We must check every user's age is 18 or older in the response data.

2. Step 2: Choose approach that parses response and asserts condition on all users

   Sending GET, parsing JSON, and asserting all ages >= 18 matches the need.

3. Final Answer:

   Send a GET request, parse JSON response, then assert all ages >= 18 -> Option A

4. Quick Check:

   Check all data items for condition [OK]

Hint: Check all items, not just one, for correct data [OK]

Common Mistakes:

• Checking only first user age
• Using wrong HTTP method for retrieval
• Verifying wrong response content type