Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/JeremySkinner/FluentValidation

A popular .NET validation library for building strongly-typed validation rules.
https://github.com/JeremySkinner/FluentValidation

Last synced: 7 days ago
JSON representation

A popular .NET validation library for building strongly-typed validation rules.

Awesome Lists containing this project

README 

        


FluentValidation




[![Build Status](https://github.com/FluentValidation/FluentValidation/workflows/CI/badge.svg)](https://github.com/FluentValidation/FluentValidation/actions?query=workflow%3ACI) [![NuGet](https://img.shields.io/nuget/v/FluentValidation.svg)](https://nuget.org/packages/FluentValidation) [![Nuget](https://img.shields.io/nuget/dt/FluentValidation.svg)](https://nuget.org/packages/FluentValidation)



[Full Documentation](https://fluentvalidation.net)



A validation library for .NET that uses a fluent interface

and lambda expressions for building strongly-typed validation rules.



---

### Supporting the project

If you use FluentValidation in a commercial project, please sponsor the project financially. FluentValidation is developed and supported by [@JeremySkinner](https://github.com/JeremySkinner) for free in his spare time and financial sponsorship helps keep the project going. You can sponsor the project via either [GitHub sponsors](https://github.com/sponsors/JeremySkinner) or [OpenCollective](https://opencollective.com/FluentValidation).



---



### Get Started



FluentValidation can be installed using the Nuget package manager or the `dotnet` CLI.



```

dotnet add package FluentValidation

```



[Review our documentation](https://docs.fluentvalidation.net) for instructions on how to use the package.



---



### Example

```csharp

using FluentValidation;



public class CustomerValidator: AbstractValidator {

  public CustomerValidator() {

    RuleFor(x => x.Surname).NotEmpty();

    RuleFor(x => x.Forename).NotEmpty().WithMessage("Please specify a first name");

    RuleFor(x => x.Discount).NotEqual(0).When(x => x.HasDiscount);

    RuleFor(x => x.Address).Length(20, 250);

    RuleFor(x => x.Postcode).Must(BeAValidPostcode).WithMessage("Please specify a valid postcode");

  }



  private bool BeAValidPostcode(string postcode) {

    // custom postcode validating logic goes here

  }

}



var customer = new Customer();

var validator = new CustomerValidator();



// Execute the validator

ValidationResult results = validator.Validate(customer);



// Inspect any validation failures.

bool success = results.IsValid;

List failures = results.Errors;

```



### License, Copyright etc



FluentValidation has adopted the [Code of Conduct](https://github.com/FluentValidation/FluentValidation/blob/main/.github/CODE_OF_CONDUCT.md) defined by the Contributor Covenant to clarify expected behavior in our community.

For more information see the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct).



FluentValidation is copyright © 2008-2022 .NET Foundation, [Jeremy Skinner](https://jeremyskinner.co.uk) and other contributors and is licensed under the [Apache2 license](https://github.com/JeremySkinner/FluentValidation/blob/master/License.txt).



### Sponsors



This project is sponsored by the following organisations whose support help keep this project going:



- [Microsoft](https://microsoft.com) for their financial contribution 

- [JetBrains](https://www.jetbrains.com/?from=FluentValidation) for providing licenses to their developer tools



This project is part of the [.NET Foundation](https://dotnetfoundation.org).