0Pricing
Node.js Backend Development Bootcamp · Aula

Testes de integração de endpoints de API

Implemente testes de integração para verificar a interação entre diferentes componentes e garantir o funcionamento da API.

Testes de integração de endpoints de API é uma aula grátis de Node.js Backend Development Bootcamp no CoddyKit. Esta é a aula 2 de 4. Você pode ler a aula completa abaixo gratuitamente — depois pratica ao vivo no navegador com um editor de código integrado e um tutor de IA 24/7. Faz parte do caminho de aprendizado de Node.js Backend Development Bootcamp, e seu progresso é sincronizado entre a web e o app CoddyKit. O curso de Node.js Backend Development Bootcamp inclui 4 aulas no total.

Partes desta aula ainda não foram traduzidas e aparecem em 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!

Perguntas Frequentes

A aula “Testes de integração de endpoints de API” é grátis?

Sim — o texto completo de “Testes de integração de endpoints de API” é grátis para ler aqui na web. Para praticá-la interativamente (um editor de código integrado e um tutor de IA 24/7) e desbloquear o restante do curso de Node.js Backend Development Bootcamp, atualize para CoddyKit PRO. O curso de Node.js Backend Development Bootcamp inclui 4 aulas no total.

O que vou aprender em “Testes de integração de endpoints de API”?

Implemente testes de integração para verificar a interação entre diferentes componentes e garantir o funcionamento da API. Você pratica Node.js Backend Development Bootcamp com código prático que executa diretamente no navegador, e um tutor de IA 24/7 responde suas dúvidas enquanto trabalha na aula.

Preciso ter experiência prévia para começar Node.js Backend Development Bootcamp?

Nenhuma experiência prévia é necessária. Node.js Backend Development Bootcamp no CoddyKit é estruturado para alunos iniciantes até avançados, então você pode começar aqui ou desde o início e aprender no seu ritmo. Esta é a aula 2 de 4.

Quanto tempo leva a aula “Testes de integração de endpoints de API”?

A maioria das aulas CoddyKit leva cerca de 5–10 minutos. Cada uma é compacta e interativa, então você faz progresso constante e retoma exatamente de onde parou entre web e app.

Posso escrever e executar código nesta aula de Node.js Backend Development Bootcamp?

Sim. Cada aula de Node.js Backend Development Bootcamp inclui um editor de código integrado, então você escreve e executa código real direto no navegador e recebe feedback de IA instantaneamente — nenhuma configuração local necessária.

Todas as aulas deste curso

  1. Testes Unitários com Jest
  2. Testes de integração de endpoints de API
  3. Técnicas eficazes de depuração
  4. Simulações e substitutos de teste em Node.js
← Voltar para Node.js Backend Development Bootcamp