Introduction to API Testing

In this tutorial, you will learn about Introduction to API Testing. We cover key concepts, practical examples, and best practices to help you master this topic.

API testing validates that APIs function correctly, handle edge cases, and perform under load. Unlike UI testing, API testing focuses on the contract between systems. It is faster, more reliable, and catches issues earlier in the development cycle.

What You'll Learn

• API testing fundamentals and benefits
• The testing pyramid: unit, integration, e2e
• API test automation vs manual testing
• Testing in CI/CD pipelines

Why It Matters

API tests catch integration issues before they reach the UI. They run in milliseconds and can be automated in CI/CD. Well-tested APIs reduce production incidents and improve developer confidence.

Real-World Use

Netflix uses API testing extensively for their microservice architecture. Stripe has a comprehensive API test suite. GitHub runs API tests on every Pull Request.

flowchart TD
    Pyramid[Test Pyramid] --> E2E[End-to-End Tests
Slow, Few]
    Pyramid --> Integration[Integration Tests
Medium Speed, Medium Count]
    Pyramid --> Unit[Unit Tests
Fast, Many]
    API[API Tests] --> Integration
    API --> E2E

Teacher Mindset

API testing is the sweet spot in the Test Pyramid. It is faster than UI tests but tests real integration points. Write API tests for every endpoint, covering success cases, error cases, and edge cases.

Code Examples

// Example 1: Basic API test with Node.js
const request = require('supertest');
const app = require('../app');

describe('GET /api/users', () => {
  it('returns user list', async () => {
    const res = await request(app)
      .get('/api/users')
      .expect(200);

    expect(res.body).toBeInstanceOf(Array);
    expect(res.body[0]).toHaveProperty('id');
    expect(res.body[0]).toHaveProperty('name');
  });

  it('returns empty array when no users', async () => {
    const res = await request(app)
      .get('/api/users')
      .expect(200);

    expect(res.body).toEqual([]);
  });
});

# Example 2: Basic API test with Python
import httpx
from pytest import mark

@mark.asyncio
async def test_get_users():
    async with httpx.AsyncClient() as client:
        response = await client.get('http://api/users')
        assert response.status_code == 200
        data = response.json()
        assert isinstance(data, list)
        assert 'id' in data[0]
        assert 'name' in data[0]

# Example 3: API test with curl and bash
#!/bin/bash
test_get_users() {
    response=$(curl -s -o /dev/null -w "%{http_code}" http://api/users)
    if [ "$response" != "200" ]; then
        echo "FAIL: Expected 200, got $response"
        exit 1
    fi
    echo "PASS: GET /api/users returns 200"
}

Common Mistakes

• Only testing the happy path and ignoring error cases
• Writing API tests that depend on test execution order
• Hardcoding test data instead of using factories or fixtures
• Not cleaning up test data after test runs
• Testing through the UI when an API test would be faster

Practice

1. Write a test for a GET endpoint that returns 200.
2. Write a test for a POST endpoint that creates a resource.
3. Write a test for a 404 response on a non-existent resource.
4. Write a test for input validation errors (400).
5. Challenge: Write API tests for all CRUD operations on one resource.

FAQ

Mini Project

Set up an API test project for a simple REST API with GET, POST, PUT, and DELETE endpoints. Write tests for each endpoint covering success and error cases. Run the tests and generate a test report.

What's Next

Next, you will learn about the different types of API testing: unit, integration, and end-to-end tests.