Testing API routes in NextJS - Performance & Optimization

Performance: Testing API routes

MEDIUM IMPACT

Testing API routes affects development speed and reliability but can indirectly impact user experience by preventing slow or broken API responses.

Testing Next.js API routes for correctness and performance

NextJS

import request from 'supertest';
import app from '../../pages/api/hello';
describe('API route /api/hello', () => {
  it('responds with 200 and JSON', async () => {
    const response = await request(app).get('/api/hello');
    expect(response.status).toBe(200);
    expect(response.body).toHaveProperty('message');
  });
});

Uses a real HTTP request simulation library to test API routes fully, including middleware and response timing.

📈 Performance GainDetects slow or broken API responses early, preventing user-facing delays or errors.

Testing Next.js API routes for correctness and performance

NextJS

import handler from '../../pages/api/hello';
test('API returns 200', async () => {
  const req = {};
  const res = { status: jest.fn().mockReturnThis(), json: jest.fn() };
  await handler(req, res);
  expect(res.status).toHaveBeenCalledWith(200);
});

Mocks request and response objects manually without simulating real HTTP behavior, missing middleware and edge cases.

📉 Performance CostCan cause false positives or negatives, leading to undetected slow API responses affecting user experience.

Performance Comparison

Pattern	DOM Operations	Reflows	Paint Cost	Verdict
Manual mocks for API testing	0 (no DOM)	0	0	[X] Bad
HTTP simulation with supertest	0 (no DOM)	0	0	[OK] Good

Rendering Pipeline

Testing API routes does not directly affect browser rendering but ensures backend responses are fast and reliable, which supports faster content loading.

→Network Request

→Server Response

⚠️ BottleneckServer Response time if API routes are slow or buggy

Optimization Tips

1Use HTTP simulation tools like supertest to test API routes realistically.

2Catch slow or broken API responses early to prevent user-facing delays.

3Testing API routes improves backend reliability, indirectly boosting page load performance.

Performance Quiz - 3 Questions

Why is using a library like supertest better than manual mocks for testing Next.js API routes?

A It reduces bundle size of the app

B It simulates real HTTP requests including middleware and timing

C It automatically improves browser rendering speed

D It eliminates the need for unit tests

DevTools: Network

How to check: Open DevTools > Network tab, reload page or trigger API call, observe response times and status codes.

What to look for: Look for fast response times (low latency) and status 200 responses indicating healthy API routes.

Practice

1. What is the main purpose of testing API routes in a Next.js application?

easy

A. To verify that the backend API responds correctly to requests

B. To style the API responses with CSS

C. To improve the frontend UI components

D. To deploy the API to production servers

Solution

1. Step 1: Understand API route role

   API routes handle backend logic and respond to client requests in Next.js.

2. Step 2: Purpose of testing API routes

   Testing ensures these routes respond correctly and handle inputs as expected.

3. Final Answer:

   To verify that the backend API responds correctly to requests -> Option A

4. Quick Check:

   API route testing = verify backend response [OK]

Hint: API route tests check backend responses, not frontend styles [OK]

Common Mistakes:

• Confusing API testing with frontend UI testing
• Thinking testing deploys the API
• Assuming API testing styles responses

2. Which of the following is the correct way to import the Next.js API route handler for testing with Jest?

easy

A. import handler from '../pages/api/hello';

B. require('../pages/api/hello');

C. import { handler } from '../pages/api/hello';

D. import * as handler from '../pages/api/hello';

Solution

1. Step 1: Identify default export usage

   Next.js API routes usually export a default function as handler.

2. Step 2: Correct import syntax for default export

   Use import handler from 'path' to import default export correctly.

3. Final Answer:

   import handler from '../pages/api/hello'; -> Option A

4. Quick Check:

   Default export import = import handler from [OK]

Hint: Use default import syntax for API route handlers [OK]

Common Mistakes:

• Using require() in ES module context
• Trying to destructure default export
• Importing all as an object unnecessarily

3. Given this test snippet for a Next.js API route handler, what will be the response status code if the handler returns res.status(200).json({ message: 'OK' })?

import handler from '../pages/api/hello';
import { createMocks } from 'node-mocks-http';

test('returns 200 status', async () => {
  const { req, res } = createMocks({ method: 'GET' });
  await handler(req, res);
  expect(res._getStatusCode()).toBe(200);
});

medium

A. 404

B. 200

C. 500

D. 400

Solution

1. Step 1: Understand handler response

   The handler sets status 200 and sends JSON with message 'OK'.

2. Step 2: Test checks status code

   The test expects status code 200, matching the handler's response.

3. Final Answer:

   200 -> Option B

4. Quick Check:

   Handler returns 200 status code [OK]

Hint: Match expected status with handler's res.status call [OK]

Common Mistakes:

• Assuming default status is 404
• Confusing JSON response with status code
• Not awaiting async handler

4. Identify the error in this test code for a Next.js API route:

import handler from '../pages/api/hello';
import { createMocks } from 'node-mocks-http';

test('returns 200 status', () => {
  const { req, res } = createMocks({ method: 'GET' });
  handler(req, res);
  expect(res._getStatusCode()).toBe(200);
});

medium

A. Using _getStatusCode instead of statusCode property

B. Incorrect import path for handler

C. Wrong method used in createMocks

D. Missing async/await for the handler call

Solution

1. Step 1: Check handler invocation

   API route handlers are async functions and must be awaited in tests.

2. Step 2: Identify missing async/await

   The test function is not async and does not await handler, causing test to run before response is set.

3. Final Answer:

   Missing async/await for the handler call -> Option D

4. Quick Check:

   Async handler needs await in test [OK]

Hint: Always await async API handlers in tests [OK]

Common Mistakes:

• Forgetting async keyword on test function
• Not awaiting the handler call
• Assuming synchronous execution

5. You want to test a Next.js API route that handles both GET and POST methods differently. Which approach correctly tests both methods in one test file?

hard

A. Use a single createMocks call with method 'GET,POST' to test both

B. Call handler once with method 'GET' and reuse the same response object for 'POST'

C. Create separate tests using createMocks with method set to 'GET' and 'POST', then call handler for each

D. Test only the GET method since POST is similar

Solution

1. Step 1: Understand method-specific testing

   Each HTTP method requires a separate mock request to simulate different behaviors.

2. Step 2: Use separate mocks for GET and POST

   CreateMocks should be called twice with method set to 'GET' and 'POST' respectively, calling handler each time.

3. Final Answer:

   Create separate tests using createMocks with method set to 'GET' and 'POST', then call handler for each -> Option C

4. Quick Check:

   Separate mocks per method = correct testing [OK]

Hint: Test each HTTP method separately with fresh mocks [OK]

Common Mistakes:

• Reusing response object across methods
• Testing only one method and ignoring others
• Trying to combine methods in one mock