Skip to main content

Making FluentValidation compatible with Swagger including Enum or fixed List support

FluentValidation is not directly compatible with Swagger API to validate models. But they do provide an interface through which we can compose Swagger validation manually. That means we look under FluentValidation validators and compose Swagger validator properties to make it compatible. More of all mapping by reading information from FluentValidation and setting it to Swagger Model Schema.
These can be done on any custom validation from FluentValidation too just that proper schema property has to be available from Swagger.

Custom validation from Enum/List values on FluentValidation

 using FluentValidation.Validators;  
 using System.Collections.Generic;  
 using System.Linq;  
 using static System.String;  
 /// <summary>  
 /// Validator as per list of items.  
 /// </summary>  
 /// <seealso cref="PropertyValidator" />  
 public class FixedListValidator  
   : PropertyValidator  
 {  
   /// <summary>  
   /// Gets the valid items  
   /// </summary>  
   public IEnumerable<string> ValidItems { get; private set; }  
   /// <summary>  
   /// Initializes a new instance of the <see cref="FixedListValidator"/> class.  
   /// </summary>  
   /// <param name="validItems">The valid items.</param>  
   public FixedListValidator(IEnumerable<string> validItems)  
     : base("{PropertyName} can contain only these values {ElementValues}.")  
   {  
     ValidItems = validItems;  
   }  
   /// <summary>  
   /// Returns true if value contains any value of <see cref="ValidItems"/>.  
   /// </summary>  
   /// <param name="context">The context.</param>  
   /// <returns>  
   ///  <c>true</c> if the specified context is valid; otherwise, <c>false</c>.  
   /// </returns>  
   protected override bool IsValid(PropertyValidatorContext context)  
   {  
     var value = context?.PropertyValue as string;  
     if (!IsNullOrEmpty(value) && !ValidItems.Contains(value))  
     {  
       context.MessageFormatter.AppendArgument("ElementValues", Join(", ", ValidItems));  
       return false;  
     }  
     return true;  
   }  
 }  

This is simple, it just looks if passed single value exists within Enum or provided list based on ruleset.

An extension method to utilise FixedList validator while composing fluent validation.

 using FluentValidation;  
 using System.Collections.Generic;  
 /// <summary>  
 /// Extension rules for FluentValidations.  
 /// </summary>  
 internal static class ExtensionCustomRule  
 {  
   /// <summary>  
   /// Must contain valid items based on passed values from <paramref name="validItems"/> parameter.  
   /// </summary>  
   /// <typeparam name="TModel">Model for validation.</typeparam>  
   /// <param name="ruleBuilder">The rule builder.</param>  
   /// <param name="validItems">The valid items.</param>  
   /// <returns>Rule builder chain.</returns>  
   public static IRuleBuilderOptions<TModel, string> MustContainValidItems<TModel>(  
       this IRuleBuilder<TModel, string> ruleBuilder, IEnumerable<string> validItems)  
     => ruleBuilder.SetValidator(new FixedListValidator(validItems));  
 }  

Now with extension method created, it is much simpler to use while composing FluentValidation RuleSet.
Ex:
   RuleFor(emp => emp.CustomerType).NotEmpty()  
         .MustContainValidItems(<Enum values to list or put any list of valuse to check against>);  

Some parts of below codes were taken from some other source but not remember the link.

Building Swagger schema based on FluentValdation rules

The schemaModel has some predefined structure, on which properties have to be set based on validation logic from FluentValidation. The same approach has been made on enum/fixed list support with earlier created custom validation from FluentValidation.

 using FluentValidation;  
 using FluentValidation.Validators;  
 using Swashbuckle.AspNetCore.Swagger;  
 using Swashbuckle.AspNetCore.SwaggerGen;  
 using System;  
 using System.Collections.Generic;  
 using System.Linq;  
 /// <summary>  
 /// Swagger validation documentation through Fluent Validations.  
 /// </summary>  
 /// <seealso cref="ISchemaFilter" />  
 public class SwaggerFluentValidation  
   : ISchemaFilter  
 {  
   /// <summary>  
   /// The service provider  
   /// </summary>  
   private readonly IServiceProvider ServiceProvider;  
   /// <summary>  
   /// Initializes a new instance of the <see cref="SwaggerFluentValidation"/> class.  
   /// </summary>  
   /// <param name="provider">The provider.</param>  
   public SwaggerFluentValidation(IServiceProvider provider)  
   {  
     ServiceProvider = provider;  
   }  
   /// <summary>  
   /// Applies the specified model.  
   /// </summary>  
   /// <param name="schemaModel">The model.</param>  
   /// <param name="context">The context.</param>  
   public void Apply(Schema schemaModel, SchemaFilterContext context)  
   {  
     // Trys to get validator from FluentValidation library.  
     // I am using ServiceProvider but approach can be changed to   
     // reference from FluentValidation registered validator.  
     var validator = ServiceProvider  
       .GetService(typeof(IValidator<>)  
       .MakeGenericType(context.SystemType)) as IValidator;  
     if (validator == null)  
     {  
       return;  
     }  
     if (schemaModel.Required == null)  
     {  
       schemaModel.Required = new List<string>();  
     }  
     var validatorDescriptor = validator.CreateDescriptor();  
     foreach (var key in schemaModel.Properties.Keys)  
     {  
       foreach (var propertyValidator in validatorDescriptor  
         .GetValidatorsForMember(ToPascalCase(key)))  
       {  
         if (propertyValidator is NotNullValidator  
           || propertyValidator is NotEmptyValidator)  
         {  
           schemaModel.Required.Add(key);  
         }  
         if (propertyValidator is LengthValidator lengthValidator)  
         {  
           if (lengthValidator.Max > 0)  
           {  
             schemaModel.Properties[key].MaxLength = lengthValidator.Max;  
           }  
           schemaModel.Properties[key].MinLength = lengthValidator.Min;  
         }  
         if (propertyValidator is RegularExpressionValidator expressionValidator)  
         {  
           schemaModel.Properties[key].Pattern = expressionValidator.Expression;  
         }  
         if (propertyValidator is FixedListValidator itemListValidator)  
         {  
           schemaModel.Properties[key].Enum = itemListValidator.ValidItems.ToList<object>();  
         }  
       }  
     }  
   }  
   /// <summary>  
   /// To convert case as swagger may be using lower camel case  
   /// </summary>  
   /// <param name="inputString">The input string.</param>  
   /// <returns>Pascal case for string.</returns>  
   private static string ToPascalCase(string inputString)  
   {  
     if (string.IsNullOrEmpty(inputString) || inputString.Length < 2)  
     {  
       return null;  
     }  
     return inputString.Substring(0, 1).ToUpper() + inputString.Substring(1);  
   }  
 }  

That is all, now SwaggerFluentValidation has to be registered on Swagger something like

 services.AddApiVersioning(o =>  
 {  
   o.AssumeDefaultVersionWhenUnspecified = true;  
   o.DefaultApiVersion = new ApiVersion(1, 0);  
 }).AddSwaggerGen(options =>  
 {  
   var provider = services.BuildServiceProvider().GetRequiredService<IApiVersionDescriptionProvider>();  
   options.ConfigureSwaggerVersions(provider);  
   options.SchemaFilter<SwaggerFluentValidation>(services.BuildServiceProvider());  
 });  


Comments

  1. This doesn't work with latest code. Now all the validators are generic

    ReplyDelete

Post a Comment

Popular posts from this blog

Elegantly dealing with TimeZones in MVC Core / WebApi

In any new application handling TimeZone/DateTime is mostly least priority and generally, if someone is concerned then it would be handled by using DateTime.UtcNow on codes while creating current dates and converting incoming Date to UTC to save on servers. Basically, the process is followed by saving DateTime to UTC format in a database and keep converting data to native format based on user region or single region in the application's presentation layer. The above is tedious work and have to be followed religiously. If any developer misses out the manual conversion, then that area of code/view would not work. With newer frameworks, there are flexible ways to deal/intercept incoming or outgoing calls to simplify conversion of TimeZones. These are steps/process to achieve it. 1. Central code for storing user's state about TimeZone. Also, central code for conversion logic based on TimeZones. 2. Dependency injection for the above class to ...

Handling JSON DateTime format on Asp.Net Core

This is a very simple trick to handle JSON date format on AspNet Core by global settings. This can be applicable for the older version as well. In a newer version by default, .Net depends upon Newtonsoft to process any JSON data. Newtonsoft depends upon Newtonsoft.Json.Converters.IsoDateTimeConverter class for processing date which in turns adds timezone for JSON data format. There is a global setting available for same that can be adjusted according to requirement. So, for example, we want to set default formatting to US format, we just need this code. services.AddMvc() .AddJsonOptions(options => { options.SerializerSettings.DateTimeZoneHandling = "MM/dd/yyyy HH:mm:ss"; });

Trim text in MVC Core through Model Binder

Trimming text can be done on client side codes, but I believe it is most suitable on MVC Model Binder since it would be at one place on infrastructure level which would be free from any manual intervention of developer. This would allow every post request to be processed and converted to a trimmed string. Let us start by creating Model binder using Microsoft.AspNetCore.Mvc.ModelBinding; using System; using System.Threading.Tasks; public class TrimmingModelBinder : IModelBinder { private readonly IModelBinder FallbackBinder; public TrimmingModelBinder(IModelBinder fallbackBinder) { FallbackBinder = fallbackBinder ?? throw new ArgumentNullException(nameof(fallbackBinder)); } public Task BindModelAsync(ModelBindingContext bindingContext) { if (bindingContext == null) { throw new ArgumentNullException(nameof(bindingContext)); } var valueProviderResult = bindingContext.ValueProvider.GetValue(bin...

Storing and restoring Kendo Grid state from Database

There is no any built in way to store entire grid state into database and restore back again with all filters, groups, aggregates, page and page size. At first, I was trying to restore only filters by looking through DataSourceRequest. DataSourceRequest is kind of communication medium between client and server for the operation we do on grid. All the request comes via DataSourceRequest. In previous approach, I was trying to store IFileDescriptor interface which come with class FileDescriptor by looping through filters and serializing into string for saving into database but this IFileDescriptor can also contain CompositeFilterDescriptor which can be nested in nested object which are very tricky to handle. So, I had decompiled entire Kendo.MVC library and found out that all Kendo MVC controls are derived from “JsonObject”. It is there own implementation with ”Serialize” abstract function and “ToJson” function. In controls they are overriding “Serialize” method which depicts t...

Configuring Ninject, Asp.Net Identity UserManager, DataProtectorTokenProvider with Owin

It can be bit tricky to configure both Ninject and Asp.Net Identity UserManager if some value is expected from DI to configure UserManager. We will look into configuring both and also use OwinContext to get UserManager. As usual, all configuration need to be done on Startup.cs. It is just a convention but can be used with different name, the important thing is to decorate class with following attribute to make it Owin start-up: [assembly: OwinStartup(typeof(MyProject.Web.Startup))] Ninject configuration Configuring Ninject kernel through method which would be used to register under Owin. Startup.cs public IKernel CreateKernel() { var kernel = new StandardKernel(); try { //kernel.Bind<IHttpModule>().To<HttpApplicationInitializationHttpModule>(); // TODO: Put any other injection which are required. return kernel; } catch { kernel.Dispose(); thro...

LDAP with ASP.Net Identity Core in MVC with project.json

Lightweight Directory Access Protocol (LDAP), the name itself explain it. An application protocol used over an IP network to access the distributed directory information service. The first and foremost thing is to add references for consuming LDAP. This has to be done by adding reference from Global Assembly Cache (GAC) into project.json "frameworks": { "net461": { "frameworkAssemblies": { "System.DirectoryServices": "4.0.0.0", "System.DirectoryServices.AccountManagement": "4.0.0.0" } } }, These  System.DirectoryServices  and  System.DirectoryServices.AccountManagement  references are used to consume LDAP functionality. It is always better to have an abstraction for irrelevant items in consuming part. For an example, the application does not need to know about PrincipalContext or any other dependent items from those two references to make it extensible. So, we can begin wi...

Kendo MVC Grid DataSourceRequest with AutoMapper - Advance

The actual process to make DataSourceRequest compatible with AutoMapper was explained in my previous post  Kendo MVC Grid DataSourceRequest with AutoMapper , where we had created custom model binder attribute and in that property names were changed as data models. In this post we will be looking into using AutoMapper's Queryable extension to retrieve the results based on selected columns. When  Mapper.Map<RoleViewModel>(data)  is called it retrieves all column values from table. The Queryable extension provides a way to retrieve only selected columns from table. In this particular case based on properties of  RoleViewModel . The previous approach that we implemented is perfect as far as this article ( 3 Tips for Using Telerik Data Access and AutoMapper ) is concern about performance where it states: While this functionality allows you avoid writing explicit projection in to your LINQ query it has the same fatal flaw as doing so - it prevents the qu...

Data seed for the application with EF, MongoDB or any other ORM.

Most of ORMs has moved to Code first approach where everything is derived/initialized from codes rather than DB side. In this situation, it is better to set data through codes only. We would be looking through simple technique where we would be Seeding data through Codes. I would be using UnitOfWork and Repository pattern for implementing Data Seeding technique. This can be applied to any data source MongoDB, EF, or any other ORM or DB. Things we would be doing. - Creating a base class for easy usage. - Interface for Seed function for any future enhancements. - Individual seed classes. - Configuration to call all seeds. - AspNet core configuration to Seed data through Seed configuration. Creating a base class for easy usage public abstract class BaseSeed<TModel> where TModel : class { protected readonly IMyProjectUnitOfWork MyProjectUnitOfWork; public BaseSeed(IMyProjectUnitOfWork MyProjectUnitOfWork) { ...

Kendo MVC Grid DataSourceRequest with AutoMapper

Kendo Grid does not work directly with AutoMapper but could be managed by simple trick using mapping through ToDataSourceResult. The solution works fine until different filters are applied. The problems occurs because passed filters refer to view model properties where as database model properties are required after AutoMapper is implemented. So, the plan is to intercept DataSourceRequest  and modify names based on database model. To do that we are going to create implementation of  CustomModelBinderAttribute to catch calls and have our own implementation of DataSourceRequestAttribute from Kendo MVC. I will be using same source code from Kendo but will replace column names for different criteria for sort, filters, group etc. Let's first look into how that will be implemented. public ActionResult GetRoles([MyDataSourceRequest(GridId.RolesUserGrid)] DataSourceRequest request) { if (request == null) { throw new Argume...