Microsoft.Extensions.Options.DataAnnotations
8.0.0
Prefix Reserved
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
<PackageReference Include="Microsoft.Extensions.Options.DataAnnotations" Version="8.0.0" />
paket add Microsoft.Extensions.Options.DataAnnotations --version 8.0.0
#r "nuget: Microsoft.Extensions.Options.DataAnnotations, 8.0.0"
// 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
Related Packages
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 | Versions 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. |
-
.NETFramework 4.6.2
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.0)
- Microsoft.Extensions.Options (>= 8.0.0)
-
.NETStandard 2.0
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.0)
- Microsoft.Extensions.Options (>= 8.0.0)
- System.ComponentModel.Annotations (>= 5.0.0)
-
.NETStandard 2.1
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.0)
- Microsoft.Extensions.Options (>= 8.0.0)
- System.ComponentModel.Annotations (>= 5.0.0)
-
net6.0
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.0)
- Microsoft.Extensions.Options (>= 8.0.0)
-
net7.0
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.0)
- Microsoft.Extensions.Options (>= 8.0.0)
-
net8.0
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.0)
- Microsoft.Extensions.Options (>= 8.0.0)
NuGet packages (364)
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 (19)
Showing the top 5 popular GitHub repositories that depend on Microsoft.Extensions.Options.DataAnnotations:
Repository | Stars |
---|---|
microsoft/semantic-kernel
Integrate cutting-edge LLM technology quickly and easily into your apps
|
|
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.
|
Version | Downloads | Last updated | |
---|---|---|---|
9.0.0-rc.2.24473.5 | 7,027 | 10/8/2024 | |
9.0.0-rc.1.24431.7 | 5,425 | 9/10/2024 | |
9.0.0-preview.7.24405.7 | 1,786 | 8/13/2024 | |
9.0.0-preview.6.24327.7 | 3,417 | 7/9/2024 | |
9.0.0-preview.5.24306.7 | 894 | 6/11/2024 | |
9.0.0-preview.4.24266.19 | 2,489 | 5/21/2024 | |
9.0.0-preview.3.24172.9 | 3,299 | 4/11/2024 | |
9.0.0-preview.2.24128.5 | 827 | 3/12/2024 | |
9.0.0-preview.1.24080.9 | 2,615 | 2/13/2024 | |
8.0.0 | 8,627,814 | 11/14/2023 | |
8.0.0-rc.2.23479.6 | 15,279 | 10/10/2023 | |
8.0.0-rc.1.23419.4 | 13,294 | 9/12/2023 | |
8.0.0-preview.7.23375.6 | 5,963 | 8/8/2023 | |
8.0.0-preview.6.23329.7 | 1,724 | 7/11/2023 | |
8.0.0-preview.5.23280.8 | 2,459 | 6/13/2023 | |
8.0.0-preview.4.23259.5 | 949 | 5/16/2023 | |
8.0.0-preview.3.23174.8 | 3,062 | 4/11/2023 | |
8.0.0-preview.2.23128.3 | 1,224 | 3/14/2023 | |
8.0.0-preview.1.23110.8 | 10,150 | 2/21/2023 | |
7.0.0 | 7,763,864 | 11/7/2022 | |
7.0.0-rc.2.22472.3 | 17,403 | 10/11/2022 | |
7.0.0-rc.1.22426.10 | 7,024 | 9/14/2022 | |
7.0.0-preview.7.22375.6 | 2,807 | 8/9/2022 | |
7.0.0-preview.6.22324.4 | 1,891 | 7/12/2022 | |
7.0.0-preview.5.22301.12 | 2,584 | 6/14/2022 | |
7.0.0-preview.4.22229.4 | 3,819 | 5/10/2022 | |
7.0.0-preview.3.22175.4 | 925 | 4/13/2022 | |
7.0.0-preview.2.22152.2 | 775 | 3/14/2022 | |
7.0.0-preview.1.22076.8 | 956 | 2/17/2022 | |
6.0.0 | 15,921,381 | 11/8/2021 | |
6.0.0-rc.2.21480.5 | 2,249 | 10/12/2021 | |
6.0.0-rc.1.21451.13 | 3,437 | 9/14/2021 | |
6.0.0-preview.7.21377.19 | 2,693 | 8/10/2021 | |
6.0.0-preview.6.21352.12 | 7,431 | 7/14/2021 | |
6.0.0-preview.5.21301.5 | 507 | 6/15/2021 | |
6.0.0-preview.4.21253.7 | 1,072 | 5/24/2021 | |
6.0.0-preview.3.21201.4 | 423 | 4/8/2021 | |
6.0.0-preview.2.21154.6 | 527 | 3/11/2021 | |
6.0.0-preview.1.21102.12 | 520 | 2/12/2021 | |
5.0.0 | 7,822,495 | 11/9/2020 | |
5.0.0-rc.2.20475.5 | 829 | 10/13/2020 | |
5.0.0-rc.1.20451.14 | 652 | 9/14/2020 | |
5.0.0-preview.8.20407.11 | 682 | 8/25/2020 | |
5.0.0-preview.7.20364.11 | 800 | 7/21/2020 | |
5.0.0-preview.6.20305.6 | 1,221 | 6/25/2020 | |
5.0.0-preview.5.20278.1 | 30,344 | 6/10/2020 | |
5.0.0-preview.4.20251.6 | 609 | 5/18/2020 | |
5.0.0-preview.3.20215.2 | 550 | 4/23/2020 | |
5.0.0-preview.2.20160.3 | 560 | 4/2/2020 | |
5.0.0-preview.1.20120.4 | 565 | 3/16/2020 | |
3.1.32 | 54,235 | 12/13/2022 | |
3.1.31 | 4,793 | 11/8/2022 | |
3.1.30 | 3,437 | 10/11/2022 | |
3.1.29 | 11,851 | 9/13/2022 | |
3.1.28 | 34,401 | 8/9/2022 | |
3.1.27 | 5,591 | 7/12/2022 | |
3.1.26 | 21,290 | 6/14/2022 | |
3.1.25 | 53,679 | 5/10/2022 | |
3.1.24 | 31,159 | 4/11/2022 | |
3.1.23 | 52,759 | 3/8/2022 | |
3.1.22 | 269,783 | 12/14/2021 | |
3.1.21 | 646,921 | 11/7/2021 | |
3.1.20 | 46,374 | 10/11/2021 | |
3.1.19 | 87,467 | 9/14/2021 | |
3.1.18 | 376,542 | 8/10/2021 | |
3.1.17 | 106,625 | 7/13/2021 | |
3.1.16 | 52,856 | 6/8/2021 | |
3.1.15 | 327,977 | 5/11/2021 | |
3.1.14 | 273,166 | 4/6/2021 | |
3.1.13 | 342,567 | 3/9/2021 | |
3.1.12 | 210,248 | 2/9/2021 | |
3.1.11 | 66,063 | 1/12/2021 | |
3.1.10 | 474,449 | 11/9/2020 | |
3.1.9 | 287,265 | 10/13/2020 | |
3.1.8 | 1,033,385 | 9/8/2020 | |
3.1.7 | 532,311 | 8/11/2020 | |
3.1.6 | 159,281 | 7/14/2020 | |
3.1.5 | 348,709 | 6/9/2020 | |
3.1.4 | 438,969 | 5/12/2020 | |
3.1.3 | 314,838 | 3/24/2020 | |
3.1.2 | 1,662,515 | 2/18/2020 | |
3.1.1 | 188,146 | 1/14/2020 | |
3.1.0 | 545,372 | 12/3/2019 | |
3.1.0-preview3.19553.2 | 710 | 11/13/2019 | |
3.1.0-preview2.19525.4 | 1,060 | 11/1/2019 | |
3.1.0-preview1.19506.1 | 1,652 | 10/15/2019 | |
3.0.3 | 4,820 | 2/18/2020 | |
3.0.2 | 3,214 | 1/14/2020 | |
3.0.1 | 8,836 | 11/18/2019 | |
3.0.0 | 221,479 | 9/23/2019 | |
3.0.0-rc1.19456.10 | 1,470 | 9/16/2019 | |
3.0.0-preview9.19423.4 | 1,615 | 9/4/2019 | |
3.0.0-preview8.19405.4 | 1,540 | 8/13/2019 | |
3.0.0-preview7.19362.4 | 1,084 | 7/23/2019 | |
3.0.0-preview6.19304.6 | 4,665 | 6/12/2019 | |
3.0.0-preview5.19227.9 | 1,294 | 5/6/2019 | |
3.0.0-preview4.19216.2 | 3,840 | 4/18/2019 | |
3.0.0-preview3.19153.1 | 633 | 3/6/2019 | |
3.0.0-preview.19074.2 | 650 | 1/29/2019 | |
3.0.0-preview.18572.1 | 668 | 12/4/2018 | |
2.2.0 | 13,894,594 | 12/3/2018 | |
2.2.0-preview3-35497 | 62,849 | 10/17/2018 | |
2.2.0-preview2-35157 | 4,862 | 9/12/2018 |