FluentChoco

KO | EN

gitlite — search

#python #hacktoberfest #react #ai #typescript #llm #machine-learning #java #windows #awesome #cli #kubernetes #mcp #open-source

(★ 23)

FluentValidation middleware for HotChocolate GraphQL

FluentChoco 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# <img align="center" src="https://raw.githubusercontent.com/dalrankov/FluentChoco/master/icon.png"/> FluentChoco

FluentValidation middleware for HotChocolate GraphQL

## How it works?

Registered FluentValidation middleware will be executed on top of GraphQL field and validate every argument value with it's registered `IValidator<T>` implementation from IServiceProvider. Validation failures, if there are any, will be reported and displayed in the response and request execution will be terminated.

## Usage

There are two ways to add FluentValidation middleware: globally (for every field) and per-field.

Global:
````csharp
services.AddGraphQLServer()
    .UseFluentValidation();
````

Code first:
````csharp
descriptor.Field("demo")
    .UseFluentValidation();
````

Pure code first:
````csharp
[UseFluentValidation]
public string Demo() => "All good!";
````

Keep in mind that adding middleware both globally and per-field will end up in field arguments being validated twice.

## Validators registration

There is an easy way to automatically register all validators from your assembly.
Also, by specifying parameters you can modify their lifetime and choose whether you want to inspect only public (exported) types or rather all types.
By default, only public (exported) types will get inspected and validators will be registered with Transient lifetime.

````csharp
services.RegisterFluentValidators<Startup>();
````

## Validator customization

There are 3 ways to customize your validator's behaviour for each argument.
- Skip validation
- Specify the rule sets to validate
- Specify the properties to validate

Code first:
````csharp
descriptor.Field("demo")
    .Argument("input1", d => d.ValidateRuleSets("CustomRule"))
    .Argument("input2", d => d.ValidateProperties("Foo", "Bar"))
    .Argument("input3", d => d.SkipValidation());
````

Pure code first:

````csharp
public string Demo(
      [ValidateRuleSets("CustomRule")] TestInput input1,
      [ValidateProperties("Foo", "Bar")] TestInput input2,
      [SkipValidation] TestInput input3)
    {
        return "All good!";
    }
````

## Error customization

You can implement `IValidationErrorBuilder` to build your own errors.

````csharp
public class CustomErrorBuilder
    : IValidationErrorBuilder
{
    public IErrorBuilder BuildError(
        IErrorBuilder builder, 
        ValidationFailure failure, 
        IInputField argument, 
        IMiddlewareContext context)
    {
        return builder.SetCode("DEMO_ERROR")
            .SetMessage(failure.ErrorMessage)
            .SetExtension("custom1", "Hey, there was an error!");
    }
}
````

Global:
````csharp
services.AddGraphQLServer()
    .UseFluentValidation<CustomErrorBuilder>();
````

Code first:
````csharp
descriptor.Field("demo")
    .UseFluentValidation<CustomErrorBuilder>();
````

Pure code first:
````csharp
[UseFluentValidation(typeof(CustomErrorBuilder))]
public string Demo() => "All good!";
````

------------------------
Icon made by [Ivana Vujačić](https://www.pinterest.com/vujacicnivana/).

FluentChoco

FluentChoco 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

FluentChoco

FluentChoco 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README