Node.js Backend Development Bootcamp · 강의

API 엔드포인트 통합 테스트

서로 다른 구성 요소 간의 상호 작용을 확인하고 API 기능이 제대로 작동하는지 검증하는 통합 테스트를 구현합니다.

API 엔드포인트 통합 테스트은(는) CoddyKit의 무료 Node.js Backend Development Bootcamp 강의입니다. 이것은 4개 중 2번째 강의입니다. 아래에서 전체 강의를 무료로 읽을 수 있으며, 내장 코드 에디터와 24/7 AI 튜터와 함께 브라우저에서 직접 실습할 수 있습니다. 이 강의는 Node.js Backend Development Bootcamp 학습 경로의 일부이며, 진행 상황이 웹과 CoddyKit 앱에 동기화됩니다. Node.js Backend Development Bootcamp 강의에는 총 4개의 강의가 포함되어 있습니다.

이 강의의 일부는 아직 번역되지 않았으며 영어로 표시됩니다.

What is Integration Testing?

Welcome! In this lesson, we'll dive into integration testing for Node.js API endpoints. Unlike unit tests (which test small, isolated pieces of code), integration tests verify that different parts of your application work together as expected.

For APIs, this means ensuring your endpoints correctly handle requests, interact with databases or other services, and return the right responses.

Why Test API Endpoints?

Your API is the main way external clients interact with your backend. Robust integration tests ensure:

Endpoints respond with correct HTTP status codes.
Data sent to the API is processed and stored properly.
The API returns expected data formats (e.g., JSON).
Different components (like routing, middleware, database) integrate seamlessly.

This helps catch bugs early that unit tests might miss.

Essential Testing Tools

To test our Node.js API endpoints, we'll use a couple of key tools:

Jest: Our test runner and assertion library (introduced in Lesson 1).
Supertest: A library designed to test HTTP servers. It makes it easy to send requests and assert responses.
Express: Our web framework, for building the API itself.

Setting Up Supertest

First, let's install the necessary packages. We'll need express for our sample API, and jest and supertest for testing.

Run this command in your project terminal:

npm install --save-dev express jest supertest

Our Simple Express App

Let's create a basic Express application that we can test. We'll define a few simple routes.

Notice we export the app instance, which Supertest will use to make requests directly, without needing to start a live server on a port.

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

// Middleware to parse JSON request bodies
app.use(express.json());

// A simple GET route
app.get('/', (req, res) => {
  res.send('Hello from Express!');
});

// A GET route that returns JSON
app.get('/data', (req, res) => {
  res.json({ message: 'API data', version: 1.0 });
});

// A POST route that echoes the request body
app.post('/echo', (req, res) => {
  res.json(req.body);
});

// Export the app for testing purposes
module.exports = app;

// Start the server only if not in a test environment
if (process.env.NODE_ENV !== 'test') {
  const port = 3000;
  app.listen(port, () => {
    console.log(`Server running on port ${port}`);
  });
}

Testing a GET Endpoint

Now, let's write our first integration test. We'll use supertest to make a GET request to our root / endpoint and assert its response.

Create a file like app.test.js and add the following:

const request = require('supertest');
const app = require('./app'); // Import our Express app

describe('GET /', () => {
  it('should return "Hello from Express!"', async () => {
    const res = await request(app).get('/');
    expect(res.statusCode).toEqual(200);
    expect(res.text).toEqual('Hello from Express!');
  });
});

Asserting JSON Responses

APIs often return JSON data. Supertest makes it easy to access the parsed JSON body of a response using res.body.

Let's test our /data endpoint to ensure it returns the correct JSON object:

const request = require('supertest');
const app = require('./app');

describe('GET /data', () => {
  it('should return JSON with message and version', async () => {
    const res = await request(app).get('/data');
    expect(res.statusCode).toEqual(200);
    expect(res.type).toEqual('application/json');
    expect(res.body).toEqual({ message: 'API data', version: 1.0 });
    expect(res.body.message).toBe('API data');
  });
});

Testing POST Requests

Testing POST requests is similar, but we'll use .post() and often .send() to attach a request body.

Our /echo endpoint simply returns whatever JSON it receives. Let's test that functionality:

const request = require('supertest');
const app = require('./app');

describe('POST /echo', () => {
  it('should echo the sent JSON data', async () => {
    const testData = { name: 'Coddy', score: 95 };
    const res = await request(app)
      .post('/echo')
      .send(testData);

    expect(res.statusCode).toEqual(200);
    expect(res.type).toEqual('application/json');
    expect(res.body).toEqual(testData);
  });
});

Database Interactions & Cleanup

When testing APIs that interact with a database, you typically:

Use a dedicated test database to prevent polluting your development data.
Clear the database before each test suite or test case (using beforeEach/afterEach hooks).
Seed data if specific data is needed for a test.

This ensures tests are independent and repeatable.

API Test Scenario

You're testing a Node.js API endpoint /users that accepts POST requests to create a new user. Which of the following statements are TRUE about integration testing this endpoint?

Recap: Integration Testing

Great job! You've learned the fundamentals of integration testing for Node.js API endpoints:

What it is: Verifying components work together, especially for API requests.
Tools: Using Supertest with Jest to simulate HTTP requests.
Method: Sending GET/POST requests and asserting status codes, body content, and data types.
Best Practices: Considering dedicated test databases for isolation.

This ensures your API is robust and reliable!

자주 묻는 질문

“API 엔드포인트 통합 테스트” 강의는 무료인가요?

네 — “API 엔드포인트 통합 테스트” 전체 내용을 이 웹사이트에서 무료로 읽을 수 있습니다. 인터랙티브하게 실습하려면(내장 코드 에디터와 24/7 AI 튜터), CoddyKit PRO로 업그레이드하면 Node.js Backend Development Bootcamp 강의 전체를 잠금 해제할 수 있습니다. Node.js Backend Development Bootcamp 강의에는 총 4개의 강의가 포함되어 있습니다.

“API 엔드포인트 통합 테스트”에서 뭘 배우나요?

서로 다른 구성 요소 간의 상호 작용을 확인하고 API 기능이 제대로 작동하는지 검증하는 통합 테스트를 구현합니다. 브라우저에서 직접 실행하는 실습 코드로 Node.js Backend Development Bootcamp을(를) 배우며, 24/7 AI 튜터가 강의를 진행하면서 질문에 답변해줍니다.

Node.js Backend Development Bootcamp을(를) 시작하는 데 경험이 필요한가요?

사전 경험은 필요하지 않습니다. CoddyKit의 Node.js Backend Development Bootcamp은(는) 초급자부터 고급 학습자까지를 위해 구성되어 있으므로, 여기서 시작하거나 처음부터 시작할 수 있으며 자신의 속도대로 진행할 수 있습니다. 이것은 4개 중 2번째 강의입니다.

“API 엔드포인트 통합 테스트” 강의는 얼마나 걸리나요?

대부분의 CoddyKit 강의는 약 5~10분이 소요됩니다. 각 강의는 간결하고 인터랙티브하여 꾸준한 진행이 가능하며, 웹과 앱에서 중단한 부분부터 바로 시작할 수 있습니다.

이 Node.js Backend Development Bootcamp 강의에서 코드를 작성하고 실행할 수 있나요?

네. 모든 Node.js Backend Development Bootcamp 강의에는 내장 코드 에디터가 포함되어 있으므로, 브라우저에서 바로 실제 코드를 작성하고 실행한 후 즉시 AI 피드백을 받을 수 있습니다 — 로컬 설정이 필요 없습니다.

이 강의의 모든 강의

← Node.js Backend Development Bootcamp(으)로 돌아가기