.NET Web API Core 7中GraphQL v7无法识别UseGraphQL方法的问题

问题场景 #

新建.NET Web API Core 7项目，集成GraphQL v7时，在Program.cs中调用app.UseGraphQL()出现CS1061错误，提示：

'WebApplication' 不包含 'UseGraphQL' 的定义，也找不到接受第一个参数为 'WebApplication' 类型的可访问扩展方法 'UseGraphQL'（是否缺少 using 指令或程序集引用？）

错误原因 #

你遗漏了两个关键要素：

• 未安装GraphQL针对ASP.NET Core的集成包，UseGraphQL扩展方法并非核心GraphQL包的一部分，而是由GraphQL.Server.AspNetCore提供
• 注释掉了using GraphQL.Server;，该命名空间包含UseGraphQL扩展方法的定义

解决步骤 #

1. 安装必要的NuGet包 #

在项目中安装GraphQL.Server.AspNetCore包，版本保持和其他GraphQL包一致（7.1.1）：

<ItemGroup>
    <PackageReference Include="GraphQL" Version="7.1.1" />
    <PackageReference Include="GraphQL.MemoryCache" Version="7.1.1" />
    <PackageReference Include="GraphQL.MicrosoftDI" Version="7.1.1" />
    <PackageReference Include="GraphQL.NewtonsoftJson" Version="7.1.1" />
    <PackageReference Include="GraphQL.SystemTextJson" Version="7.1.1" />
    <PackageReference Include="GraphQL.Server.AspNetCore" Version="7.1.1" /> <!-- 添加这一行 -->
    <PackageReference Include="Microsoft.VisualStudio.Azure.Containers.Tools.Targets" Version="1.17.0" />
  </ItemGroup>

2. 恢复或添加命名空间引用 #

取消Program.cs中using GraphQL.Server;的注释，或者直接添加该行：

using GraphQL;
using Erapi.Graphql.Queries;
using GraphQL.Types;
using Erapi.Graphql.Notes;
using GraphQL.MicrosoftDI;
using GraphQL.Server; // 取消注释或添加这一行

3. 修正后的完整Program.cs代码 #

using GraphQL;
using Erapi.Graphql.Queries;
using GraphQL.Types;
using Erapi.Graphql.Notes;
using GraphQL.MicrosoftDI;
using GraphQL.Server;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddSingleton<ISchema, NotesSchema>(services => new NotesSchema(new SelfActivatingServiceProvider(services)));
builder.Services.AddGraphQL(options =>
                    options.ConfigureExecution((opt, next) =>
                    {
                        opt.EnableMetrics = true;
                        return next(opt);
                    }).AddSystemTextJson()
                );

builder.Services.AddCors(options =>
{
    options.AddDefaultPolicy(
        builder =>
        {
            builder.WithOrigins("*")
                   .AllowAnyHeader();
        });
});

builder.Services.AddControllers();

var app = builder.Build();

app.UseHttpsRedirection();

app.UseCors();

//app.UseAuthorization();

app.MapControllers();

app.UseGraphQL(); // 现在可以正常使用

await app.RunAsync();

补充说明 #

GraphQL核心包仅提供基础的GraphQL功能，要在ASP.NET Core中注册GraphQL中间件，必须依赖GraphQL.Server.AspNetCore这类集成包，它提供了UseGraphQL、UseGraphQLPlayground等扩展方法，用于快速配置GraphQL端点和调试界面。

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