Microsoft.Extensions.Options.DataAnnotations 8.0.0

Prefix Reserved
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package Microsoft.Extensions.Options.DataAnnotations --version 8.0.0                
NuGet\Install-Package Microsoft.Extensions.Options.DataAnnotations -Version 8.0.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Microsoft.Extensions.Options.DataAnnotations" Version="8.0.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Microsoft.Extensions.Options.DataAnnotations --version 8.0.0                
#r "nuget: Microsoft.Extensions.Options.DataAnnotations, 8.0.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Microsoft.Extensions.Options.DataAnnotations as a Cake Addin
#addin nuget:?package=Microsoft.Extensions.Options.DataAnnotations&version=8.0.0

// Install Microsoft.Extensions.Options.DataAnnotations as a Cake Tool
#tool nuget:?package=Microsoft.Extensions.Options.DataAnnotations&version=8.0.0                

About

Microsoft.Extensions.Options.DataAnnotations is a library that adds extra validation functionality to configuration options using data annotations.

It allows to apply validation rules to configuration classes to ensure they are correctly configured before the application starts running.

This way, misconfiguration issues are catched early during the application startup rather than facing them later in production.

Key Features

  • Enables validation of configuration options using data annotations.
  • Early detection of misconfiguration issues during application startup.

How to Use

While configuring services, chain the ValidateDataAnnotations() and ValidateOnStart() methods to the AddOptions method for your configuration class.

Here is a simple example demonstrating how to validate options on application startup:

services
    .AddOptions<MyOptions>()
    .ValidateDataAnnotations()
    .ValidateOnStart();

In the configuration class, use data annotations to specify the validation rules.

For instance, in the following MyOptions class, the Name property is marked as required:

using System.ComponentModel.DataAnnotations;

public class MyOptions
{
    [Required(AllowEmptyStrings = false)]
    public string Name { get; set; }
}

With this setup, an error indicating that the Name field is required will be thrown upon startup if it hasn't been configured.

Main Types

The main types provided by this library are:

  • Microsoft.Extensions.Options.DataAnnotationsValidateOptions<TOptions>
  • Microsoft.Extensions.DependencyInjection.OptionsBuilderDataAnnotationsExtensions

Additional Documentation

Core options: Microsoft.Extensions.Options

Feedback & Contributing

Microsoft.Extensions.Options.DataAnnotations is released as open source under the MIT license. Bug reports and contributions are welcome at the GitHub repository.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 is compatible.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (259)

Showing the top 5 NuGet packages that depend on Microsoft.Extensions.Options.DataAnnotations:

Package Downloads
Microsoft.AspNetCore.App

Provides a default set of APIs for building an ASP.NET Core application. This package requires the ASP.NET Core runtime. This runtime is installed by the .NET Core SDK, or can be acquired separately using installers available at https://aka.ms/dotnet-download.

Microsoft.AspNetCore.All

Provides a default set of APIs for building an ASP.NET Core application, and also includes API for third-party integrations with ASP.NET Core. This package requires the ASP.NET Core runtime. This runtime is installed by the .NET Core SDK, or can be acquired separately using installers available at https://aka.ms/dotnet-download.

Umbraco.Cms.Core

Contains the core assembly needed to run Umbraco CMS.

VirtoCommerce.Platform.Core

Virto Commerce is a flexible B2B ecommerce solution that offers powerful tools for enterprise business users. https://virtocommerce.com

Stl

Stl ("ServiceTitan Library") is a collection of relatively small abstractions or methods we couldn't find in BCL. A part of Stl.Fusion.

GitHub repositories (16)

Showing the top 5 popular GitHub repositories that depend on Microsoft.Extensions.Options.DataAnnotations:

Repository Stars
umbraco/Umbraco-CMS
Umbraco is a free and open source .NET content management system helping you deliver delightful digital experiences.
TelegramBots/Telegram.Bot
.NET Client for Telegram Bot API
servicetitan/Stl.Fusion
Build real-time apps (Blazor included) with less than 1% of extra code responsible for real-time updates. Host 10-1000x faster APIs relying on transparent and nearly 100% consistent caching. We call it DREAM, or Distributed REActive Memoization, and it's here to turn real-time on!
Finbuckle/Finbuckle.MultiTenant
Finbuckle.MultiTenant is an open-source multitenancy middleware library for .NET. It enables tenant resolution, per-tenant app behavior, and per-tenant data isolation.
VirtoCommerce/vc-platform
Virto Commerce B2B Innovation Platform
Version Downloads Last updated
9.0.0-preview.6.24327.7 137 7/9/2024
9.0.0-preview.5.24306.7 389 6/11/2024
9.0.0-preview.4.24266.19 1,135 5/21/2024
9.0.0-preview.3.24172.9 1,380 4/11/2024
9.0.0-preview.2.24128.5 757 3/12/2024
9.0.0-preview.1.24080.9 2,272 2/13/2024
8.0.0 3,894,241 11/14/2023
8.0.0-rc.2.23479.6 14,428 10/10/2023
8.0.0-rc.1.23419.4 11,982 9/12/2023
8.0.0-preview.7.23375.6 5,418 8/8/2023
8.0.0-preview.6.23329.7 1,628 7/11/2023
8.0.0-preview.5.23280.8 2,374 6/13/2023
8.0.0-preview.4.23259.5 875 5/16/2023
8.0.0-preview.3.23174.8 2,986 4/11/2023
8.0.0-preview.2.23128.3 1,100 3/14/2023
8.0.0-preview.1.23110.8 9,815 2/21/2023
7.0.0 6,770,341 11/7/2022
7.0.0-rc.2.22472.3 16,211 10/11/2022
7.0.0-rc.1.22426.10 6,820 9/14/2022
7.0.0-preview.7.22375.6 2,594 8/9/2022
7.0.0-preview.6.22324.4 1,814 7/12/2022
7.0.0-preview.5.22301.12 2,512 6/14/2022
7.0.0-preview.4.22229.4 3,751 5/10/2022
7.0.0-preview.3.22175.4 817 4/13/2022
7.0.0-preview.2.22152.2 690 3/14/2022
7.0.0-preview.1.22076.8 870 2/17/2022
6.0.0 14,385,613 11/8/2021
6.0.0-rc.2.21480.5 2,190 10/12/2021
6.0.0-rc.1.21451.13 3,383 9/14/2021
6.0.0-preview.7.21377.19 2,620 8/10/2021
6.0.0-preview.6.21352.12 7,044 7/14/2021
6.0.0-preview.5.21301.5 441 6/15/2021
6.0.0-preview.4.21253.7 933 5/24/2021
6.0.0-preview.3.21201.4 352 4/8/2021
6.0.0-preview.2.21154.6 473 3/11/2021
6.0.0-preview.1.21102.12 464 2/12/2021
5.0.0 7,256,761 11/9/2020
5.0.0-rc.2.20475.5 778 10/13/2020
5.0.0-rc.1.20451.14 586 9/14/2020
5.0.0-preview.8.20407.11 611 8/25/2020
5.0.0-preview.7.20364.11 732 7/21/2020
5.0.0-preview.6.20305.6 1,165 6/25/2020
5.0.0-preview.5.20278.1 27,419 6/10/2020
5.0.0-preview.4.20251.6 541 5/18/2020
5.0.0-preview.3.20215.2 490 4/23/2020
5.0.0-preview.2.20160.3 502 4/2/2020
5.0.0-preview.1.20120.4 491 3/16/2020
3.1.32 37,149 12/13/2022
3.1.31 4,531 11/8/2022
3.1.30 3,206 10/11/2022
3.1.29 11,372 9/13/2022
3.1.28 31,938 8/9/2022
3.1.27 5,324 7/12/2022
3.1.26 21,057 6/14/2022
3.1.25 50,019 5/10/2022
3.1.24 29,771 4/11/2022
3.1.23 50,951 3/8/2022
3.1.22 223,650 12/14/2021
3.1.21 542,756 11/7/2021
3.1.20 43,822 10/11/2021
3.1.19 81,818 9/14/2021
3.1.18 280,438 8/10/2021
3.1.17 105,237 7/13/2021
3.1.16 49,459 6/8/2021
3.1.15 327,554 5/11/2021
3.1.14 267,350 4/6/2021
3.1.13 325,448 3/9/2021
3.1.12 191,517 2/9/2021
3.1.11 64,499 1/12/2021
3.1.10 458,512 11/9/2020
3.1.9 283,203 10/13/2020
3.1.8 1,011,483 9/8/2020
3.1.7 499,312 8/11/2020
3.1.6 157,989 7/14/2020
3.1.5 338,074 6/9/2020
3.1.4 419,820 5/12/2020
3.1.3 311,416 3/24/2020
3.1.2 1,639,738 2/18/2020
3.1.1 182,781 1/14/2020
3.1.0 521,947 12/3/2019
3.1.0-preview3.19553.2 639 11/13/2019
3.1.0-preview2.19525.4 999 11/1/2019
3.1.0-preview1.19506.1 1,593 10/15/2019
3.0.3 4,152 2/18/2020
3.0.2 3,000 1/14/2020
3.0.1 8,571 11/18/2019
3.0.0 212,880 9/23/2019
3.0.0-rc1.19456.10 1,379 9/16/2019
3.0.0-preview9.19423.4 1,500 9/4/2019
3.0.0-preview8.19405.4 1,445 8/13/2019
3.0.0-preview7.19362.4 982 7/23/2019
3.0.0-preview6.19304.6 4,526 6/12/2019
3.0.0-preview5.19227.9 1,180 5/6/2019
3.0.0-preview4.19216.2 3,576 4/18/2019
3.0.0-preview3.19153.1 563 3/6/2019
3.0.0-preview.19074.2 595 1/29/2019
3.0.0-preview.18572.1 605 12/4/2018
2.2.0 13,461,088 12/3/2018
2.2.0-preview3-35497 62,561 10/17/2018
2.2.0-preview2-35157 4,740 9/12/2018