Mercurius项目中禁用GET路由的方法详解

Mercurius作为Fastify生态中的GraphQL实现，提供了灵活的配置选项来满足不同场景下的需求。本文将详细介绍如何在Mercurius中禁用默认的GET路由，以便开发者能够自定义路由处理逻辑。

为什么需要禁用GET路由

在GraphQL服务开发中，有时我们需要在同一个路径上实现不同的功能。例如，开发者可能希望在/graphql路径上同时提供：

1. GraphQL查询服务（POST请求）
2. GraphiQL或Altair等可视化工具界面（GET请求）

Mercurius默认会为GraphQL端点注册GET和POST两种HTTP方法的路由。当我们需要在同一个路径上实现自定义的GET请求处理时，就需要先禁用Mercurius的默认GET路由。

配置方法

Mercurius提供了简单的配置选项来禁用默认路由：

await server.register(mercurius, {
  schema,
  resolvers,
  path: '/graphql',
  routes: false  // 禁用所有自动注册的路由
});

设置routes: false后，Mercurius将不会自动注册任何路由，开发者需要手动注册所需的路由。

完整实现示例

下面是一个完整的实现示例，展示了如何禁用默认路由并自定义GET请求处理：

// 注册Altair可视化工具
await server.register(fastifyAltairPlugin, {
  path: '/graphql',
  baseURL: '/graphql',
  endpointURL: '/graphql',
  initialSettings: {
    theme: 'dark',
    'plugin.list': ['altair-graphql-plugin-graphql-explorer'],
  },
});

// 注册Mercurius并禁用自动路由
await server.register(mercurius, {
  schema,
  resolvers,
  path: '/graphql',
  routes: false
});

// 手动注册GraphQL POST路由
server.route({
  method: 'POST',
  url: '/graphql',
  handler: async (req, reply) => {
    return reply.graphql(req.body);
  }
});

注意事项

1. 当禁用自动路由后，开发者需要确保手动注册了所有必要的路由，包括GraphQL查询和订阅等。

2. 如果只需要禁用GET路由而保留POST路由，可以设置routes: { get: false }：

await server.register(mercurius, {
  schema,
  resolvers,
  path: '/graphql',
  routes: {
    get: false  // 仅禁用GET路由
  }
});

3. 在自定义路由处理程序时，需要注意请求和响应的格式与GraphQL规范保持一致。

通过这种灵活的配置方式，Mercurius能够很好地适应各种复杂的应用场景，为开发者提供最大的自由度来构建符合需求的GraphQL服务。