如何将 header 添加到 NestJS v8 + GraphQL 中的所有响应？

Question

我想为 NestJS 框架 (v8) 中的所有响应添加具有价值的自定义 header。我认为正确的方法是使用全局拦截器，但我不知道该怎么做。

我正在添加我的拦截器：

app.useGlobalInterceptors(new HeadersInterceptor());

我发现了多种方法，但其中 none 有效。最常见的样子：

import { CallHandler, ExecutionContext, Injectable, NestInterceptor } from '@nestjs/common';
import { Observable, tap } from 'rxjs';

@Injectable()
export class HeadersInterceptor implements NestInterceptor {
  intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
    return next.handle().pipe(
      tap(() => {
        const res = context.switchToHttp().getResponse();

        res.setHeader('my-global-header', 'important-value');
      }),
    );
  }
}

但我收到一个错误：

res.setHeader is not a function

编辑：从正确答案来看，我应该提到我也在使用 GraphQL。

Answer 1

您可以简单地在响应对象上使用 set 方法

res.set('my-global-header', 'important-value')

我相信 setHeader 是 express.static() 中提供的选项之一。您可以查看有关此

的文档

Answer 2

您的代码看起来不错。如果您尝试使用 express 的 Response 接口会怎样？

import { Response } from 'express';

@Injectable()
export class HeadersInterceptor implements NestInterceptor {
  intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
    const res: Response = context.switchToHttp().getResponse();

    res.setHeader('my-global-header', 'important-value');

    return next.handle();
  }
}

Answer 3

这取决于 NestJS 正在执行的上下文。这里我有 GraphQL 和 HTTP 上下文的示例。

import { CallHandler, ExecutionContext, Injectable, NestInterceptor } from '@nestjs/common';
import { GqlExecutionContext } from '@nestjs/graphql';
import { Response } from 'express';
import { Observable } from 'rxjs';

@Injectable()
export class VersionHeaderInterceptor implements NestInterceptor {
  intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
    // When the request is GraphQL
    if ((context.getType() as string) === 'graphql') {
      const gqlExecutionContext = GqlExecutionContext.create(context);
      const response: Response = gqlExecutionContext.getContext().res;
      response.setHeader('x-version', process.env.npm_package_version);
    }

    // When the request is HTTP
    if (context.getType() === 'http') {
      const http = context.switchToHttp();
      const response: Response = http.getResponse();
      response.setHeader('x-version', process.env.npm_package_version);
    }

    return next.handle();
  }
}

如何将 header 添加到 NestJS v8 + GraphQL 中的所有响应？

How to add header to all responses in NestJS v8 + GraphQL?

javascript

response-headers

typescript

graphql

nestjs