Guia Passo a Passo: Implementando um Interceptor para Formatar Respostas em uma API NestJS

Guia Passo a Passo: Implementando um Interceptor para Formatar Respostas em uma API NestJS

Passo 1: Criar o Interceptor

Crie um novo arquivo chamado format-response.interceptor.ts para o interceptor:


// format-response.interceptor.ts
import { Injectable, NestInterceptor, ExecutionContext, CallHandler } from '@nestjs/common';
import { Observable } from 'rxjs';
import { map } from 'rxjs/operators';

@Injectable()
export class FormatResponseInterceptor implements NestInterceptor {
  intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
    return next.handle().pipe(
      map(data => ({
        result: {
          httpCode: context.switchToHttp().getResponse().statusCode,
          httpMessage: context.switchToHttp().getResponse().statusMessage,
          status: context.switchToHttp().getResponse().statusCode >= 200 &&
            context.switchToHttp().getResponse().statusCode < 300,
          data,
          transaction: {
            localTransactionId: '123456', // Substitua isso com a lógica desejada
            localTransactionDate: new Date().toISOString(),
          },
        },
      })),
    );
  }
}
    

Passo 2: Registrar o Interceptor no Módulo

Vá para o arquivo app.module.ts e registre o interceptor no módulo:


// app.module.ts
import { Module } from '@nestjs/common';
import { APP_INTERCEPTOR } from '@nestjs/core';
import { FormatResponseInterceptor } from './path-to-your-interceptor/format-response.interceptor';
import { YourController } from './path-to-your-controller/your.controller';

@Module({
  controllers: [YourController],
  providers: [
    {
      provide: APP_INTERCEPTOR,
      useClass: FormatResponseInterceptor,
    },
  ],
})
export class AppModule {}
    

Certifique-se de ajustar os caminhos ('./path-to-your-interceptor/' e './path-to-your-controller/') para corresponder aos caminhos reais no seu projeto.

Passo 3: Testar

Agora, ao acessar suas rotas, o interceptor formatará automaticamente as respostas de acordo com o modelo desejado.

Isso é tudo! Esses passos devem ajudar a implementar um interceptor para formatar as respostas da sua API no NestJS. Certifique-se de ajustar conforme necessário para atender às suas necessidades específicas.

Você achou esse artigo útil?