Why testing APIs matters in Express - See It in Action

Why Testing APIs Matters

📖 Scenario: You are building a simple Express API for a small online store. You want to make sure your API works correctly before letting customers use it.

🎯 Goal: Learn how to set up a basic Express API and understand why testing each API endpoint is important to catch errors early and ensure smooth user experience.

📋 What You'll Learn

Create a basic Express server with one GET endpoint

Add a configuration variable for the port number

Implement the main API route that returns a fixed product list

Add a final line to start the server listening on the configured port

💡 Why This Matters

🌍 Real World

APIs are the backbone of modern web apps. Testing them ensures users get correct data and smooth experiences.

💼 Career

Backend developers must build and test APIs to create reliable services that frontend apps and clients depend on.

1

Set up Express and create a basic server

Create a constant called express that requires the 'express' module. Then create a constant called app by calling express().

Express

const express = require('express');
const app = express();
// Your code here

Hint

Use require('express') to import Express and call it to create your app.

2

Add a configuration variable for the port

Create a constant called PORT and set it to 3000.

Express

const express = require('express');
const app = express();
const PORT = 3000;
// Your code here

Hint

Set PORT to 3000 so your server knows which port to listen on.

3

Create a GET endpoint to return products

Use app.get with the path '/products' and a callback with parameters req and res. Inside the callback, send a JSON response with an array of two products: { id: 1, name: 'Book' } and { id: 2, name: 'Pen' }.

Express

const express = require('express');
const app = express();
const PORT = 3000;

// Your code here

Hint

Use app.get to create a route and res.json to send the product list.

4

Start the server listening on the port

Call app.listen with PORT and a callback function that logs 'Server running on port 3000'.

Express

const express = require('express');
const app = express();
const PORT = 3000;

app.get('/products', (req, res) => {
  res.json([
    { id: 1, name: 'Book' },
    { id: 2, name: 'Pen' }
  ]);
});

// Your code here

Hint

Use app.listen to start your server and log a message when ready.

Practice

1. Why is testing APIs important in Express applications?

easy

A. It automatically updates the API documentation.

B. It makes the app run faster on the server.

C. It helps find and fix problems early before users see them.

D. It reduces the size of the API code.

Solution

1. Step 1: Understand the purpose of API testing

   Testing APIs helps catch bugs and errors early in development.

2. Step 2: Identify the benefit of early problem detection

   Finding problems early prevents issues from reaching users and causing failures.

3. Final Answer:

   It helps find and fix problems early before users see them. -> Option C

4. Quick Check:

   API testing = early bug detection [OK]

Hint: Testing finds bugs early to avoid user issues [OK]

Common Mistakes:

• Thinking testing speeds up server runtime
• Confusing testing with documentation generation
• Believing testing reduces code size

2. Which of the following is the correct way to write a simple test for an Express API endpoint using a testing library like Jest and Supertest?

easy

A. app.get('/api').expect(200);

B. request(app).get('/api').expect(200).end(done);

C. request('/api').get(app).expect(200);

D. expect(request(app).get('/api')).toBe(200);

Solution

1. Step 1: Recognize the correct testing syntax

   Using Supertest, you call request(app).get('/api') to test the endpoint.

2. Step 2: Confirm chaining with expect and end

   The correct pattern chains .expect(200) and .end(done) to complete the test.

3. Final Answer:

   request(app).get('/api').expect(200).end(done); -> Option B

4. Quick Check:

   Supertest syntax = request(app).get().expect() [OK]

Hint: Supertest uses request(app).get(url).expect(status) [OK]

Common Mistakes:

• Calling expect directly on app.get instead of request
• Swapping app and URL in request call
• Using expect incorrectly without chaining

3. Consider this Express API test snippet using Jest and Supertest:

test('GET /users returns 200 and JSON', async () => {
  const response = await request(app).get('/users');
  expect(response.status).toBe(200);
  expect(response.headers['content-type']).toMatch(/json/);
});

What will happen if the API returns status 404 instead of 200?

medium

A. The test will fail because the status is not 200.

B. The test will pass because content-type is checked.

C. The test will throw a syntax error.

D. The test will ignore the status and pass.

Solution

1. Step 1: Analyze the status check in the test

   The test expects response.status to be exactly 200.

2. Step 2: Understand test behavior on mismatch

   If the API returns 404, the expect(response.status).toBe(200) assertion fails and the test fails.

3. Final Answer:

   The test will fail because the status is not 200. -> Option A

4. Quick Check:

   Status check fails test if not 200 [OK]

Hint: Expect status 200; else test fails [OK]

Common Mistakes:

• Assuming test passes if content-type matches
• Thinking 404 triggers syntax error
• Believing test ignores status mismatch

4. You wrote this Express API test but it always times out:

test('POST /login returns 200', (done) => {
  request(app)
    .post('/login')
    .send({ username: 'user', password: 'pass' })
    .expect(200);
});

What is the main reason for the timeout?

medium

A. Missing call to done() to signal test completion.

B. Incorrect HTTP method used for /login endpoint.

C. The .send() method is not supported in Supertest.

D. The test expects 200 but server returns 500.

Solution

1. Step 1: Check test callback usage

   The test uses done callback but never calls done(), so Jest waits forever.

2. Step 2: Understand how to end async tests

   Calling done() inside .end() or returning a promise is needed to finish the test.

3. Final Answer:

   Missing call to done() to signal test completion. -> Option A

4. Quick Check:

   Call done() to end async test [OK]

Hint: Always call done() or return promise in async tests [OK]

Common Mistakes:

• Forgetting to call done() in callback tests
• Assuming .send() is unsupported
• Guessing wrong HTTP method without checking

5. You want to ensure your Express API handles errors correctly. Which testing approach best helps catch unexpected server errors early?

hard

A. Skip testing and rely on console logs for errors.

B. Manually test the API endpoints once after deployment.

C. Only test the API when users report bugs.

D. Write automated tests that simulate invalid inputs and check for 4xx or 5xx responses.

Solution

1. Step 1: Identify best practice for error handling tests

   Automated tests simulating invalid inputs help verify API returns proper error codes.

2. Step 2: Understand benefits of early automated error detection

   This approach finds bugs before deployment and prevents user impact.

3. Final Answer:

   Write automated tests that simulate invalid inputs and check for 4xx or 5xx responses. -> Option D

4. Quick Check:

   Automated error tests catch bugs early [OK]

Hint: Test invalid inputs automatically to catch errors early [OK]

Common Mistakes:

• Relying only on manual or post-deployment testing
• Ignoring error cases in tests
• Depending on logs instead of tests