DataAnnotations-based validation extension for WorkflowForge providing validation capabilities for workflow operations, inputs, and data flow.
Get Started
$ dotnet add package WorkflowForge.Extensions.ValidationReadme
WorkflowForge.Extensions.Validation
Validation extension for WorkflowForge with DataAnnotations-based validation for comprehensive input validation.
No External Validation Dependencies
This extension uses System.ComponentModel.DataAnnotations, so you get validation without additional third-party validation libraries.
Installation
dotnet add package WorkflowForge.Extensions.Validation
Requires: .NET Standard 2.0 or later
Quick Start
using WorkflowForge.Extensions.Validation;
using System.ComponentModel.DataAnnotations;
// Define validator
public class Order : IValidatableObject
{
[Required(ErrorMessage = "Customer ID required")]
public string CustomerId { get; set; } = string.Empty;
[Range(0.01, double.MaxValue, ErrorMessage = "Amount must be positive")]
public decimal Amount { get; set; }
[MinLength(1, ErrorMessage = "Order must have items")]
public string[] Items { get; set; } = Array.Empty<string>();
public IEnumerable<System.ComponentModel.DataAnnotations.ValidationResult> Validate(ValidationContext context)
{
if (!CustomerId.StartsWith("CUST-"))
yield return new System.ComponentModel.DataAnnotations.ValidationResult(
"Customer ID must start with 'CUST-'",
new[] { nameof(CustomerId) });
}
}
// Configure validation
using var foundry = WorkflowForge.CreateFoundry("ValidatedWorkflow");
foundry.SetProperty("Order", order);
foundry.UseValidation(f => f.GetPropertyOrDefault<Order>("Order"));
// Validation runs before every operation
await smith.ForgeAsync(workflow, foundry);
Key Features
- DataAnnotations Validation: Attributes and IValidatableObject support
- Middleware-Based: Validates before operations execute
- Flexible Extraction: Custom data extraction from foundry
- Configurable Behavior: Throw or log validation failures
- Property Validation: Validate foundry properties
- Rich Error Messages: Detailed validation error information
Configuration
Via appsettings.json
{
"WorkflowForge": {
"Extensions": {
"Validation": {
"Enabled": true,
"ThrowOnValidationError": true,
"LogValidationErrors": true,
"StoreValidationResults": true,
"IgnoreValidationFailures": false
}
}
}
}
Via Code
using WorkflowForge.Extensions.Validation.Options;
var options = new ValidationMiddlewareOptions
{
Enabled = true,
ThrowOnValidationError = true,
LogValidationErrors = true,
StoreValidationResults = true
};
foundry.UseValidation(f => f.GetPropertyOrDefault<Order>("Order"), options);
Via Dependency Injection
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using WorkflowForge.Extensions.Validation;
services.AddValidationConfiguration(configuration);
var options = serviceProvider.GetRequiredService<IOptions<ValidationMiddlewareOptions>>().Value;
See Configuration Guide for complete options.
Validation Examples
Complex Validation Rules
public class Order : IValidatableObject
{
[Required]
public string CustomerId { get; set; } = string.Empty;
[Range(0.01, 10000)]
public decimal Amount { get; set; }
[EmailAddress]
public string? Email { get; set; }
public IEnumerable<System.ComponentModel.DataAnnotations.ValidationResult> Validate(ValidationContext context)
{
if (CustomerId.Length < 5)
yield return new System.ComponentModel.DataAnnotations.ValidationResult(
"Customer ID must be at least 5 characters",
new[] { nameof(CustomerId) });
}
}
Custom Error Handling
foundry.UseValidation(
f => f.GetPropertyOrDefault<Order>("Order"),
new ValidationMiddlewareOptions { ThrowOnValidationError = false });