发布服务时如何禁用nuwave lighthouse的GraphQL API文档入口

你提到的可列出全量API内容的文档入口，本质是GraphQL规范的Introspection（内省）查询能力，配合Lighthouse默认自带的可视化调试页面实现，按以下步骤操作即可完全关闭：

1. 禁用核心内省查询能力 #

内省查询是拉取全量接口结构、生成文档的核心接口，Lighthouse内置了直接的配置开关，无需自行写逻辑拦截：

• 打开项目配置文件 config/lighthouse.php，找到security配置节点下的introspection项，调整为读取环境变量控制：

'security' => [
    // 其余安全配置保持默认即可
    'introspection' => [
        'enabled' => env('GRAPHQL_INTROSPECTION_ENABLED', false),
    ],
],

• 在生产环境的.env文件中添加配置，明确关闭内省：

GRAPHQL_INTROSPECTION_ENABLED=false

• 执行命令清理配置缓存使配置生效：

php artisan config:cache

配置生效后，所有请求全量Schema结构的内省查询都会被直接拦截，无法拉取完整API文档内容，且正常业务接口调用完全不受影响。

2. 关闭内置可视化调试/文档页面 #

Lighthouse默认自带的GraphQL Playground、GraphiQL页面本身就是带文档浏览能力的调试入口，生产环境需要同步关闭：

• 还是在config/lighthouse.php配置文件中，找到playground配置节点：

'playground' => [
    'enable' => env('GRAPHQL_PLAYGROUND_ENABLED', false),
    // 其余路由、路径配置保持默认
],

• 生产环境.env中添加配置关闭Playground页面：

GRAPHQL_PLAYGROUND_ENABLED=false

• 如果项目单独开启了GraphiQL页面，找到同配置文件下的graphiql节点，将enable项同样设为环境变量控制，生产环境置为false即可。

3. 旧版本兼容方案 #

如果你使用的是5.0以下的低版本Lighthouse，没有内置内省控制开关，可以通过自定义中间件实现拦截：

• 执行命令生成中间件文件：

php artisan make:middleware BlockGraphQLIntrospection

• 在中间件的handle方法中添加生产环境拦截逻辑：

public function handle($request, Closure $next)
{
    if (app()->environment('production') && str_contains($request->input('query', ''), '__schema')) {
        abort(403, '内省查询已在生产环境禁用');
    }
    return $next($request);
}

• 将该中间件挂载到GraphQL接口对应的路由中间件组中即可生效。

提示：如果内部运维/开发需要临时访问文档，可以在上述拦截逻辑中追加IP白名单判断，仅允许办公网IP访问内省能力，兼顾安全和调试需求。

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