Trax .NET
View as MarkdownEdit on GitHub

Reference

GraphQLClientAttribute

Package Trax.Api.GraphQL.ClientNamespace Trax.Api.GraphQL.ClientSource GraphQLClientAttribute.cs

Names the keyed client a request type belongs to, by the key passed to AddKeyedTraxGraphQLClient.

Signature

[AttributeUsage(AttributeTargets.Class, Inherited = false, AllowMultiple = false)]
public sealed class GraphQLClientAttribute : Attribute
{
    public GraphQLClientAttribute(object key);
    public object Key { get; }
}

Properties

PropertyDescription
KeyThe service key of the client the request belongs to, compared with Equals: a string or an enum value matching the one the client was registered with

Behavior

  • The constructor throws ArgumentNullException for a null key.
  • Validation for a keyed client (UseStartupValidation on its builder, or the keyed overload of ValidateGraphQLClientAssembliesAsync) checks only the request types marked with its key. The unkeyed client's validation checks only the unmarked types.
  • A request marked with a key no client is registered under fails both validations with InvalidOperationException.
  • The mark is read from the request type itself, not inherited.
  • Running a request does not read it: the executor the request is run through decides which server it goes to.

Example

[GraphQLClient("billing")]
public sealed class GetInvoiceTotalRequest : IGraphQLClientRequest<decimal>
{
    public required string Id { get; init; }
 
    public string Query => "query InvoiceTotal($id: ID!) { invoice(id: $id) { total } }";
 
    public object? Variables => new { id = Id };
}

See also