The API Test Pyramid

Lesson content

🎯 Goal By the end of this lesson, you'll understand: What is the API Test Pyramid? Why do we need it? Types of tests in the pyramid Unit Testing Integration Testing API Testing End-to-End (E2E) Testing Real-world examples Interview questions What is the API Test Pyramid? The API Test Pyramid is a testing strategy that recommends writing more low-level tests and fewer high-level tests . It helps build applications that are: Reliable Faster to test Easier to maintain Less expensive to test Simple Definition: The API Test Pyramid shows how many tests should be written at each testing level. Why Do We Need the Test Pyramid? Without proper testing: Bugs reach production Features break unexpectedly Development slows down Maintenance becomes difficult The Test Pyramid helps catch bugs early. Test Pyramid Diagram ▲ │ End-to-End Tests (Few, Slow, Expensive) │ API / Integration Tests (Some, Medium Speed) │ Unit Tests (Many, Fast, Low Cost) ▼ Levels of the Test Pyramid Level Number of Tests Speed Unit Tests Most Fast API / Integration Tests Moderate Medium End-to-End Tests Few Slow 1. Unit Testing Unit tests verify a small piece of code , usually a single function. Example function add ( a , b ) { return a + b ; } Test test ( "adds two numbers" , () => { expect ( add ( 2 , 3 )) . toBe( 5 ); }); Characteristics of Unit Tests Fast Independent Easy to write No database required No API calls 2. Integration Testing Integration tests verify that multiple components work together . Example: Route │ Controller │ Service │ Database The test checks whether these components interact correctly. Integration Example POST /users │ ▼ Controller │ ▼ Service │ ▼ Database If the user is saved successfully, the integration test passes. 3. API Testing API tests verify that the API behaves correctly. They check: Status Codes Response Body Headers Authentication Validation Example GET /users Expected 200 OK Response [ { "id": 1 , "name": "Ajay" } ] API Test Example (Jest + Supertest) Install npm install --save-dev jest supertest Example const request = require ( "supertest" ); const app = require ( "../app" ); test ( "GET /users" , async () => { const response = await request ( app ) . get( "/users" ); expect ( response . status) . toBe( 200 ); }); 4. End-to-End (E2E) Testing E2E tests verify the entire application from the user's perspective. Example: User Login │ ▼ Browse Products │ ▼ Add to Cart │ ▼ Checkout │ ▼ Payment Successful Everything works together. Real-Life Example 🏦 Imagine a bank. Unit Test Check ATM PIN Validation Integration Test ATM │ ▼ Bank Server │ ▼ Database API Test POST /login Returns 200 OK End-to-End Test Customer Login Transfer Money Receive Confirmation Entire flow is tested. Comparison Table Feature Unit Integration API E2E Speed Fast Medium Medium Slow Database ❌ Usually No ✅ Often Yes ✅ Usually Yes ✅ Yes Network ❌ No Sometimes ✅ Yes ✅ Yes Cost Low Medium Medium High Reliability High High High High Quantity Many Some Some Few Test Execution Flow Write Code │ ▼ Unit Tests │ ▼ Integration Tests │ ▼ API Tests │ ▼ End-to-End Tests │ ▼ Production Example in Node.js Project project/ │ ├── src/ ├── tests/ │ ├── unit/ │ ├── integration/ │ ├── api/ │ └── e2e/ │ ├── package.json └── app.js Popular Testing Tools Tool Purpose Jest Unit Testing Supertest API Testing Mocha Unit & Integration Testing Chai Assertions Cypress End-to-End Testing Playwright End-to-End Testing Postman Manual API Testing Testing Flow Developer │ ▼ Write Code │ ▼ Run Unit Tests │ ▼ Run Integration Tests │ ▼ Run API Tests │ ▼ Run E2E Tests │ ▼ Deploy Benefits of API Testing ✅ Faster than UI testing ✅ Finds backend bugs early ✅ Validates business logic ✅ Verifies authentication and authorization ✅ Easy to automate Real-Life Example 🛒 Shopping Website Unit Test Calculate Price │ Integration Test Order + Payment │ API Test POST /orders │ E2E Test Customer Places Order Successfully Interview Question What is the API Test Pyramid? Answer The API Test Pyramid is a testing strategy that recommends writing many fast unit tests, a moderate number of integration and API tests, and only a few end-to-end tests. Which tests should be written the most? Answer Unit Tests Which tests are the slowest? Answer End-to-End Tests Which testing library is commonly used for API testing in Node.js? Answer Supertest Which testing framework is commonly used with Node.js? Answer Jest Best Practices ✅ Write many Unit Tests. ✅ Test APIs using Supertest. ✅ Keep E2E tests limited to critical user journeys. ✅ Mock external services in Unit Tests. ✅ Run automated tests in CI/CD pipelines. ✅ Keep tests independent and repeatable. ❌ Don't rely only on manual testing. ❌ Don't write too many slow E2E tests. Key Points ✅ The Test Pyramid promotes more Unit Tests and fewer E2E Tests. ✅ Unit Tests are fast and test individual functions. ✅ Integration Tests verify multiple components working together. ✅ API Tests validate endpoints, status codes, authentication, and responses. ✅ E2E Tests verify complete user workflows. ✅ A balanced testing strategy improves quality while keeping test execution fast. 🧠 Easy Formula Write Code │ ▼ Unit Tests (Many) │ ▼ Integration Tests (Some) │ ▼ API Tests (Some) │ ▼ E2E Tests (Few) │ ▼ Deploy Unit = Function Integration = Components Together API = Endpoint Testing E2E = Complete User Journey Remember: 🧪 Unit Tests = Test one function 🔗 Integration Tests = Test multiple components together 🌐 API Tests = Test REST API endpoints 👤 E2E Tests = Test the complete application flow 🚀 Write many Unit Tests, some Integration/API Tests, and only a few E2E Tests for a healthy testing strategy