Typescript e Node.js para iniciantes – Middlewares – Custom Response

Neste artigo, vamos falar sobre middlewares e custom response em Typescript e Node.js.

Middlewares em Node.js

Os middlewares são funções que têm acesso ao objeto de solicitação (req), ao objeto de resposta (res) e à próxima função de middleware no ciclo de solicitação-resposta do aplicativo. Eles são usados para realizar tarefas comuns a várias rotas, como autenticação, validação de dados, tratamento de erros, entre outros.

Custom Response

Quando estamos construindo uma API em Node.js, é comum que precisemos padronizar as respostas para facilitar o entendimento e o consumo por parte dos clientes da API. Para isso, podemos criar um middleware de custom response para formatar as respostas de acordo com um padrão definido.

Exemplo de Custom Response em Typescript e Node.js

Abaixo, temos um exemplo de como criar um middleware de custom response em Typescript e Node.js:

        
import { Request, Response, NextFunction } from 'express';

export function customResponse(req: Request, res: Response, next: NextFunction) {
    res.sendSuccess = (data: any) => {
        res.status(200).json({ success: true, data });
    };

    res.sendError = (message: string, status: number = 500) => {
        res.status(status).json({ success: false, message });
    };

    next();
}
        
    

Neste exemplo, estamos criando um middleware de custom response que adiciona os métodos sendSuccess e sendError ao objeto de resposta (res). Esses métodos podem ser utilizados para enviar respostas com o formato padronizado.

Utilizando o Middleware de Custom Response

Para utilizar o middleware de custom response em nossas rotas, basta incluí-lo como um dos middlewares das rotas desejadas:

        
import express from 'express';
import { customResponse } from './customResponseMiddleware';

const app = express();

app.use(customResponse);

app.get('/users', (req, res) => {
    const users = [{ id: 1, name: 'John' }, { id: 2, name: 'Jane' }];
    res.sendSuccess(users);
});

app.listen(3000, () => {
    console.log('Server is running on port 3000');
});
        
    

Neste exemplo, estamos utilizando o middleware de custom response para formatar a resposta da rota /users com o formato definido pelo middleware.

Conclusão

Os middlewares e a custom response são ferramentas poderosas para padronizar e facilitar o desenvolvimento de APIs em Node.js. Com eles, podemos melhorar a legibilidade e a consistência das respostas, facilitando o consumo por parte dos clientes. Espero que este artigo tenha sido útil para você começar a utilizar esses conceitos em seus projetos. Até a próxima!