Feathers V5如何设置自定义响应头？Prometheus端点配置问题

方案1：在Metrics服务方法中直接设置响应头 #

修改你通过feathers generate service生成的metrics.service.ts，在find方法里直接操作Koa的响应对象：

import type { ServiceParams } from '@feathersjs/feathers';
import { KoaContext } from '@feathersjs/koa';
import promClient from 'prom-client';

export class MetricsService {
  async find(params: ServiceParams & { koa: KoaContext }) {
    // 获取Koa的response实例
    const { res } = params.koa;
    
    // 设置自定义Content-Type响应头
    res.setHeader('Content-Type', 'text/plain; version=0.0.4; charset=utf-8');
    // 可添加其他自定义头
    res.setHeader('X-Custom-Header', 'Hello World');
    
    // 返回Prometheus指标内容
    return promClient.register.metrics();
  }
}

方案2：使用Hook设置响应头 #

编写一个Hook，通过context.params.koa获取Koa上下文来设置响应头：

import type { HookContext } from '@feathersjs/feathers';
import { KoaContext } from '@feathersjs/koa';

export const setContentTypeHeader = (context: HookContext & { params: { koa: KoaContext } }) => {
  const { res } = context.params.koa;
  
  res.setHeader('Content-Type', 'text/plain; version=0.0.4; charset=utf-8');
  res.setHeader('X-Custom-Header', 'Hello World');
};

然后在metrics.service.ts的服务配置中，将这个Hook挂载到find方法的before钩子：

import { hooks as schemaHooks } from '@feathersjs/schema';
import { setContentTypeHeader } from './hooks/set-content-type-header';

export const metricsHooks = {
  around: {
    all: [],
    find: []
  },
  before: {
    all: [],
    find: [setContentTypeHeader] // 挂载钩子
  },
  after: {
    all: []
  },
  error: {
    all: []
  }
};

方案3：使用Koa全局中间件（针对特定路由） #

在app.ts中，通过Feathers的Koa实例添加中间件，仅对/metrics路由生效：

import { koa } from '@feathersjs/koa';

// 先配置Koa适配器
app.configure(koa());

// 添加针对metrics路由的响应头中间件
app.koa.use(async (ctx, next) => {
  await next();
  
  // 仅在访问GET /metrics时设置头
  if (ctx.path === '/metrics' && ctx.method === 'GET') {
    ctx.set('Content-Type', 'text/plain; version=0.0.4; charset=utf-8');
    ctx.set('X-Custom-Header', 'Hello World');
  }
});

关键说明 #

• 你之前尝试的context.result.headers方式无效，因为Feathers中context.result的headers属性是用于内部响应格式的元数据，并非HTTP响应头。
• Feathers v5的app对象不直接支持app.use()添加Koa中间件，需通过app.koa.use()操作底层Koa实例。

内容的提问来源于stack exchange，提问作者Sergey Podlazov