[英]How to format response before sending in Nest.js?
I followed the documentation and was able to add an interceptor for response mapping.我遵循了文档,并且能够为响应映射添加一个拦截器。
I want a consistent json format output for responses.我想要一个一致的 json 格式输出用于响应。
How can I achieve this with interceptor or with something else better than this approach.我如何使用拦截器或其他比这种方法更好的方法来实现这一点。
{
"statusCode": 201,
"message": "Custom Dynamic Message"
"data": {
// properties
meta: {}
}
}
transform.interceptor.ts transform.interceptor.ts
import {
Injectable,
NestInterceptor,
ExecutionContext,
CallHandler,
} from '@nestjs/common';
import { Observable } from 'rxjs';
import { map } from 'rxjs/operators';
export interface Response<T> {
statusCode: number;
data: T;
}
@Injectable()
export class TransformInterceptor<T>
implements NestInterceptor<T, Response<T>> {
intercept(
context: ExecutionContext,
next: CallHandler,
): Observable<Response<T>> {
return next
.handle()
.pipe(
map((data) => ({
statusCode: context.switchToHttp().getResponse().statusCode,
data,
})),
);
}
}
app.controller.ts app.controller.ts
export class AppController {
@Post('login')
@UseGuards(AuthGuard('local'))
@ApiOperation({ summary: 'Login user' })
@ApiBody({ type: LoginDto })
@ApiOkResponse({ content: { 'application/json': {} } })
@UseInterceptors(TransformInterceptor)
async login(@Request() req) {
const result = await this.authService.login(req.user);
return { message: 'Thank you!', result };
}
}
If I am understanding what you are doing with your controller response and your overall interceptor response, what you can do is something similar:如果我了解您对控制器响应和整体拦截器响应所做的事情,您可以做的是类似的事情:
import {
Injectable,
NestInterceptor,
ExecutionContext,
CallHandler,
} from '@nestjs/common';
import { Observable } from 'rxjs';
import { map } from 'rxjs/operators';
export interface Response<T> {
statusCode: number;
message: string;
data: T;
}
@Injectable()
export class TransformInterceptor<T>
implements NestInterceptor<T, Response<T>> {
intercept(
context: ExecutionContext,
next: CallHandler,
): Observable<Response<T>> {
return next
.handle()
.pipe(
map((data) => ({
statusCode: context.switchToHttp().getResponse().statusCode,
message: data.message
data: {
result: data.result,
meta: {} // if this is supposed to be the actual return then replace {} with data.result
}
})),
);
}
}
And keep your controller return as {message: 'Custom message', result}
.并让您的控制器返回为{message: 'Custom message', result}
。
Another option, which would require more upfront but possible allow for cleaner code would be to create a custom decorator that reflected a value (message) from the class and method and then retrieved that value in the interceptor after injecting the reflector, but again, that would take more upfront effort to set up.另一种需要更多前期但可能允许更清晰代码的选项是创建一个自定义装饰器,该装饰器反映来自类和方法的值(消息),然后在注入反射器后在拦截器中检索该值,但同样,将需要更多的前期努力来设置。
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.