Search  
Always will be ready notify the world about expectations as easy as possible: job change page
Apr 1, 2024

Fluent Validation in .NET Core

Fluent Validation in .NET Core
Source:
Views:
3203

Fluent validation is a third party library for validating your models in .NET. It is totally free.

Why fluent validation?

If you already have used data annotation for validation, then you must be aware of validation in .NET. So you might be thinking why do we need fluent validation.

Fluent validation helps you to separate validation logic from your models. That makes you code clean. If you have complex validation logic, then you want to define it separately rather than making your model unreadable.

If you have small scale project and does not have complex validation logic, then using data annotation makes more sense.

You can use the hybrid validation, it is totally up to you and what suits you best. None of them is good or bad. It depends on your requirements.

Create a project or use existing one

We will create a .net core project with template .Net Core Web Api. If you have existing project (for practicing) , then it is good. Don’t waste your precious time on creating a new one.

.NET Core Web API

Folder structure

Folder structure

Model

// Models/Person.cs
public class Person
{
    public int Id { get; set; }
    public string ? Name { get; set; }
    public string? Email { get; set; }
    public int Age { get; set; }
}

Easiest way (Data annotation)

Data annotation is the easiest way to validate your models..Nothing is wrong with it. It is fast and well suited for small projects. You must be familiar it with. Below is the example of it.

// Models/Person.cs
public class Person
{
    public int Id { get; set; }
    [Required]
    [MaxLength(50)]
    public string ? Name { get; set; }
    [Required]
    [MaxLength(50)]
    public string? Email { get; set; }
    public int Age { get; set; }
}

Fluent Validation

Fluent validation is a third party library which is free. So you need to install it first.

install-package FluentValidation.AspNetCore

Remove all the data annotation from Person.cs (if you are using)

// Models/Person.cs

public class Person
{
    public int Id { get; set; }
    public string ? Name { get; set; }
    public string? Email { get; set; }
    public int Age { get; set; }
}

Validator

We will create a separate class PersonValidator inside Validators directory. There we will define all the validation logic.

Validators/PersonValidator.cs

// Validators/PersonValidator.cs

using FluentValidation;
using net9demo.Models;

namespace net9demo.Validators;

public class PersonValidator: AbstractValidator<Person>
{
    public PersonValidator()
    {
      RuleFor(person=>person.Name).NotNull().MaximumLength(50);
      RuleFor(person=>person.Email).NotNull().MaximumLength(50);
    }
}

These rules are self explanatory.

First & Second rule, Name will be not null and Maximum Length will be 50.

Program.cs

You need some configuration in Program.cs to make validation work.

builder.Services
.AddControllers()
.AddFluentValidation(fv=>fv.RegisterValidatorsFromAssemblyContaining<Person>());

Person Controller

// PersonController.cs
using Microsoft.AspNetCore.Mvc;
using net9demo.Models;

namespace net9demo.Controllers;

[Route("api/people")]
[ApiController]
public class PersonController
{
    [HttpPost]
    public IActionResult AddPerson(Person person )
    {
        try
        {
            return CreatedAtAction(nameof(AddPerson),person);
        }
        catch (Exception ex)
        {
         
            return StatusCode(StatusCodes.Status500InternalServerError, ex.Message);
        }
    }
}

Test with Swagger UI

Swagger request
Request

Swagger response
Response

Email validator

RuleFor(person=>person.Email).NotNull().MaximumLength(50).EmailAddress();

Regular Expression and custom message

RuleFor(person => person.Password)
.NotEmpty()
.NotNull()
.MaximumLength(20)
.Matches("^(?=.*\\d).*$")
.WithMessage("Password must contain numeric value");

For more detail please visit official docs of fluent validation.

Similar
Jun 1, 2024
Author: Akalanka Dissanayake
In the second part of our series, the focus shifts towards validating the security and reliability of our ASP.NET 8 Web API through comprehensive integration testing. Integration testing plays a critical role in ensuring that our authentication mechanisms work as...
Apr 12, 2023
Author: Jaimin Soni
HTTP/3 is the latest version of the HTTP protocol, built on top of the QUIC transport protocol. It offers several advantages over its predecessors, including faster and more reliable connections, improved security, and reduced latency. In this article, we will...
Jun 26, 2021
SignalR is a popular software library that allows you send server code to client-side applications, like a React application. This tutorial will show you how to install SignalR on both your ASP.NET Core and React Typescript application. Creating your Applications...
Jun 15, 2021
Author: Emre Kizildas
Hi everyone, this article include encrypting your database columns with EntityFramework. Your database providers can be MSSQL or PostgreSQL. Considering that some database columns contain confidential data, it is of great importance that the data is encrypted in case of...
Send message
Type
Email
Your name
*Message