0Pricing
Node.js Backend Development Bootcamp · Lección

Pruebas de integración de endpoints de API

Implemente pruebas de integración para verificar la interacción entre distintos componentes y garantizar el funcionamiento de la API.

Pruebas de integración de endpoints de API es una lección gratuita de Node.js Backend Development Bootcamp en CoddyKit. Esta es la lección 2 de 4. Puedes leer la lección completa abajo gratuitamente — luego la practicas en el navegador con un editor de código integrado y un tutor de IA 24/7. Forma parte de la ruta de aprendizaje de Node.js Backend Development Bootcamp, y tu progreso se sincroniza en la web y la app de CoddyKit. El curso de Node.js Backend Development Bootcamp incluye 4 lecciones en total.

Partes de esta lección aún no han sido traducidas y se muestran en inglés.

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!

Preguntas frecuentes

¿La lección «Pruebas de integración de endpoints de API» es gratis?

Sí — el texto completo de «Pruebas de integración de endpoints de API» es gratis para leer aquí en la web. Para practicarla de forma interactiva (editor de código integrado y tutor de IA 24/7) y desbloquear el resto del curso de Node.js Backend Development Bootcamp, actualiza a CoddyKit PRO. El curso de Node.js Backend Development Bootcamp incluye 4 lecciones en total.

¿Qué aprenderé en «Pruebas de integración de endpoints de API»?

Implemente pruebas de integración para verificar la interacción entre distintos componentes y garantizar el funcionamiento de la API. Practicas Node.js Backend Development Bootcamp con código real que ejecutas directamente en el navegador, y un tutor de IA 24/7 responde tus preguntas mientras trabajas en la lección.

¿Necesito experiencia previa para empezar Node.js Backend Development Bootcamp?

No se requiere experiencia previa. Node.js Backend Development Bootcamp en CoddyKit está estructurado para principiantes hasta estudiantes avanzados, así que puedes empezar aquí o desde el inicio y avanzar a tu ritmo. Esta es la lección 2 de 4.

¿Cuánto tiempo toma la lección «Pruebas de integración de endpoints de API»?

La mayoría de las lecciones de CoddyKit toman alrededor de 5–10 minutos. Cada una es compacta e interactiva, así que avanzas constantemente y retomas exactamente por donde dejaste en la web y la app.

¿Puedo escribir y ejecutar código en esta lección de Node.js Backend Development Bootcamp?

Sí. Cada lección de Node.js Backend Development Bootcamp incluye un editor de código integrado, así que escribes y ejecutas código real directamente en tu navegador y obtienes retroalimentación instantánea de IA — sin configuración local necesaria.

Todas las lecciones de este curso

  1. Pruebas unitarias con Jest
  2. Pruebas de integración de endpoints de API
  3. Técnicas eficaces de depuración
  4. Mocks y dobles de prueba en Node.js
← Volver a Node.js Backend Development Bootcamp