HotChocolate を使用して GraphQL のオブジェクト型に Key ディレクティブを適用する方法

HotChocolate での GraphQL オブジェクト タイプの Key ディレクティブの実装

このソリューションは、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 の単体テスト

これは、xUnit フレームワークを使用して、HotChocolate サーバーが GraphQL スキーマの @key ディレクティブを適切に適用することを確認する C# 単体テストです。

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 の構築を簡素化します。この戦略により、一貫した高パフォーマンスのスキーマ ステッチを維持しながら、サービスをより簡単に拡張できます。