如何使用 HotChocolate 将 Key 指令应用于 GraphQL 中的对象类型

在 HotChocolate 中实现 GraphQL 对象类型的关键指令

该解决方案使用 C#、HotChocolate 和 Apollo Federation 从后端修改 GraphQL 架构。

using HotChocolate;
using HotChocolate.Types;
using HotChocolate.Types.Relay;
using Microsoft.Extensions.DependencyInjection;
public class Parent
{
    public Parent(string id, string name)
    {
        Id = id;
        Name = name;
    }
    [Key]
    [ID]
    public string Id { get; }
    public string Name { get; }
    [ReferenceResolver]
    public static Parent? Get(ParentRepository repository, string id)
    {
        return repository.GetParent(id);
    }
}
public class Query
{
    public Parent GetParent(string id, [Service] ParentRepository repository)
    {
        return repository.GetParent(id);
    }
}
public void ConfigureServices(IServiceCollection services)
{
    services.AddGraphQLServer()
        .AddQueryType<Query>()
        .RegisterService<ParentRepository>()
        .AddApolloFederation();
}

使用 GraphQL 模式第一种方法来应用 @key 指令

该解决方案使用模式优先方法以及 GraphQL SDL 和 HotChocolate 通过 @key 指令构建自定义模式。

type Parent @key(fields: "id") {
    id: ID!
    name: String!
}
extend type Query {
    parent(id: ID!): Parent
}
extend type Mutation {
    createParent(id: ID!, name: String!): Parent
}
directive @key(fields: String!) on OBJECT | INTERFACE

schema {
    query: Query
    mutation: Mutation
}

使用 @key 指令对 HotChocolate GraphQL 进行单元测试

下面是一个 C# 单元测试，它使用 xUnit 框架来确保 HotChocolate 服务器正确应用 GraphQL 架构中的 @key 指令。

using Xunit;
using HotChocolate.Execution;
using Microsoft.Extensions.DependencyInjection;
public class ParentTests
{
    [Fact]
    public async Task ParentSchema_ContainsKeyDirective()
    {
        var serviceCollection = new ServiceCollection();
        serviceCollection.AddGraphQLServer()
            .AddQueryType<Query>()
            .AddApolloFederation();
        var serviceProvider = serviceCollection.BuildServiceProvider();
        var schema = await serviceProvider.GetRequiredService<ISchemaAsync>().ExecuteAsync();
        Assert.Contains("@key(fields: \"id\")", schema.ToString());
    }
}

关于 HotChocolate 和 Apollo Federation 的常见问题

1. Apollo Federation 如何有利于 GraphQL 开发？
2. Apollo Federation 允许您将 GraphQL 模式拆分为许多服务，每个服务负责模式的一部分，但仍保持一致的 API。
3. 什么是 @key HotChocolate 中使用的指令？
4. 这 @key 指令为实体创建唯一标识符，使其能够跨多个 GraphQL 服务进行解析。
5. 我可以使用吗 [Key] 和 [ID] HotChocolate 中的属性在一起吗？
6. 是的， [Key] 财产用于联邦，并且 [ID] 将该字段指定为架构内的标识符。
7. 什么是 .RegisterService 用热巧克力做什么？
8. .RegisterService 向 GraphQL 服务器注册服务（例如存储库），从而在解析器中启用依赖项注入。
9. 如何使用 HotChocolate 测试 GraphQL 模式？
10. HotChocolate 通过调用模式并检查类似指令来使用单元测试来启用模式测试 @key 在结果中。

结束联邦进程

使用热巧克力 @钥匙 指令确保您的联邦 GraphQL 架构 已针对 Apollo Federation 进行适当配置。这种方法改进了对象类型管理并允许跨服务实体解析。

使用 HotChocolate 并使用类似指令配置 GraphQL 服务器 @钥匙 简化了大型分布式 API 的构建。此策略使您能够更轻松地扩展服务，同时保持一致的高性能模式拼接。