devdeer.Libraries.AspNetCore.RestApi 10.5.8

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package devdeer.Libraries.AspNetCore.RestApi --version 10.5.8                

                    
                

            
NuGet\Install-Package devdeer.Libraries.AspNetCore.RestApi -Version 10.5.8
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="devdeer.Libraries.AspNetCore.RestApi" Version="10.5.8" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add devdeer.Libraries.AspNetCore.RestApi --version 10.5.8                

                    
                

            
#r "nuget: devdeer.Libraries.AspNetCore.RestApi, 10.5.8"
#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 devdeer.Libraries.AspNetCore.RestApi as a Cake Addin
#addin nuget:?package=devdeer.Libraries.AspNetCore.RestApi&version=10.5.8

// Install devdeer.Libraries.AspNetCore.RestApi as a Cake Tool
#tool nuget:?package=devdeer.Libraries.AspNetCore.RestApi&version=10.5.8

devdeer.Libraries.AspNetCore.RestApi

Disclaimer

If you want to use this package you should be aware of some principles and practices we at DEVDEER use. So be aware that this is not backed by a public repository. The purpose here is to give out customers easy access to our logic. Nevertheless you are welcome to use this lib if it provides any advantages.

Summary

This package is used to provide startup logic, base types and other specific logic to ASP.NET Core API projects.

Please keep in mind that this package is not intended to be used in UI web projects!

Usage

One of the main purposes for this packages was the fact, that the initial configuration of ASP.NET APIs can be overwhelming. You need to inject dependencies and app components in the correct order. Also you often want to put configuration of those things to outside stores (appsettings.json in our case). This package now reduces all of this to only some lines of code. You could use this as follows in the Program.cs:

var options = new ConfigurationOptions
{
    // your explicit options and callbacks
};
var builder = WebApplication.CreateBuilder(args);
builder.Host.ConfigureLogging();
builder.Services.ConfigureServices(builder.Configuration, options);
// your additional DI here
var app = builder.Build();
app.ConfigureDefaults(options);
app.Run();

Now it is crucial to unserstand that ConfigureLogging(), ConfigureServices() and ConfigureDefaults() are methods coming from this package. The outcome can be controlled in 2 ways:

  1. Usage of ConfigurationOptions. You can define some of the wanted behavior using this type and pass it in.
  2. Putting elements in your appsettings.*.json.

Some common app settings are:

{
    "AzureAd": {
		"Instance": "https://login.microsoftonline.com/",
		"TenantId": "",
		"Domain": ""
	},
	"Cors": {
		"EnableCors": true,
		"AllowCredentials": false,
		"AllowedHeaders": ["*"],
		"AllowedMethods": ["GET", "POST"]
	},
    "Swagger": {
		"ApiDescription": "",
		"DeprecatedApiMessage": "<p><strong><span style='color:white;background-color:red'>DEPRECATED</span></strong></p>",
		"Contact": {
			"Name": "",
			"Email": ""
		},
		"SupportedVersions": [{
			"Major": 1,
			"Minor": 0
		}],
		"Enable": true
	}
}

Using the syntax above will automatically configure the respective services in the correct order with just two lines of code.

More Details

Swagger

We are automatically referencing Swashbuckle and configuring it if the app is running in Development and the app config tells us to do it. By default we are using versioned APIs meaning that all controllers are expected to expose endpoints using a version.

Authentication

If the AzureAd config option is set we automatically configure authentication to AzureAD or Azure AD B2C.

About DEVDEER

DEVDEER is a company from Magdeburg, Germany which is specialized in consulting, project management and development. We are very focussed on Microsoft Azure as a platform to run our products and solutions in the cloud. So all of our backend components usually runs in this environment and is developed using .NET. In the frontend area we are using react and a huge bunch of packages to build our UIs.

You can find us online:

Product Compatible and additional computed target framework versions.
.NET 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 was computed.  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 was computed.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
16.4.7 146 11/1/2024
16.4.6 160 10/30/2024
16.4.5 78 10/30/2024
16.4.4 75 10/30/2024
16.4.3 158 10/27/2024
16.4.2 77 10/27/2024
16.4.1 76 10/27/2024
16.4.0 89 10/27/2024
16.3.3 174 10/14/2024
16.3.2 89 10/14/2024
16.3.1 136 10/12/2024
16.3.0 153 10/3/2024
16.2.2 398 8/23/2024
16.2.1 483 6/27/2024
16.2.0 105 6/27/2024
16.1.5 407 6/12/2024
16.1.4 87 6/12/2024
16.1.3 382 5/30/2024
16.1.2 101 5/29/2024
16.1.1 108 5/28/2024
16.1.0 92 5/28/2024
16.0.0 106 5/24/2024
15.0.1 135 5/19/2024
15.0.0 140 5/14/2024
14.4.3 95 5/14/2024
14.4.1 321 4/19/2024
14.4.0 124 4/19/2024
14.3.0 214 3/21/2024
14.2.0 327 3/11/2024
14.1.1 126 3/9/2024
14.1.0 116 3/9/2024
14.0.1 388 2/18/2024
14.0.0 537 1/20/2024
13.0.5 129 1/18/2024
13.0.4 360 12/25/2023
13.0.3 122 12/25/2023
13.0.2 290 12/11/2023
13.0.0 138 12/10/2023
12.7.5 295 11/9/2023
12.7.4 143 11/9/2023
12.7.3 199 10/29/2023
12.7.2 154 10/29/2023
12.7.1 250 9/27/2023
12.7.0 170 9/16/2023
12.6.4 174 9/14/2023
12.6.2 185 9/8/2023
12.6.1 171 9/7/2023
12.6.0 161 9/6/2023
12.5.0 488 8/15/2023
12.4.1 150 8/15/2023
12.4.0 165 8/15/2023
12.3.0 648 5/30/2023
12.2.1 172 5/29/2023
12.2.0 198 5/24/2023
12.1.0 191 5/24/2023
12.0.0 195 5/24/2023
11.0.5 698 5/23/2023
11.0.4 175 5/23/2023
11.0.3 169 5/23/2023
11.0.2 221 5/21/2023
11.0.1 190 5/21/2023
11.0.0 179 5/21/2023
10.6.0 193 5/21/2023
10.5.13 986 4/12/2023
10.5.12 227 4/12/2023
10.5.11 231 4/12/2023
10.5.10 470 4/12/2023
10.5.9 263 4/6/2023
10.5.8 435 3/14/2023
10.5.7 252 3/14/2023
10.5.6 659 3/11/2023
10.5.5 703 1/13/2023
10.5.4 561 1/10/2023
10.5.3 359 1/4/2023
10.5.2 331 1/3/2023
10.5.1 495 12/29/2022
10.5.0 575 12/29/2022
10.4.2 350 12/29/2022
10.4.0 677 12/23/2022
10.2.24 1,405 10/19/2022
10.2.23 446 10/19/2022
10.2.22 400 10/18/2022
10.2.21 407 10/17/2022
10.2.20 418 10/17/2022
10.2.19 436 10/17/2022
10.2.18 677 9/13/2022
10.2.17 1,239 9/13/2022
10.2.16 873 9/7/2022
10.2.15 714 9/6/2022
10.2.14 1,035 9/6/2022
10.2.13 475 9/6/2022
10.2.12 700 9/6/2022
10.2.11 692 9/6/2022
10.2.10 661 9/6/2022
10.2.9 885 9/5/2022
10.2.8 577 8/15/2022
10.2.7 514 8/13/2022
10.2.6 661 8/5/2022
10.2.5 652 7/19/2022
10.2.4 1,265 5/16/2022
10.2.3 558 5/16/2022
10.2.2 1,452 3/20/2022
10.2.0 648 3/20/2022
10.1.1 653 3/18/2022
10.1.0 617 3/14/2022
10.0.0 669 3/1/2022
9.0.4 668 2/28/2022
9.0.3 1,792 1/24/2022
9.0.2 561 12/22/2021
9.0.1 393 12/22/2021
9.0.0 391 12/22/2021
8.0.5 961 12/1/2021
8.0.3 1,038 8/14/2021
8.0.2 560 8/14/2021
8.0.1 661 8/14/2021
8.0.0 471 8/9/2021
7.0.13 1,378 7/12/2021
7.0.12 895 6/9/2021
7.0.11 1,287 5/1/2021
7.0.10 1,023 5/1/2021
1.4.0 749 8/25/2020

- Nuget updates
- Updated the BaseApplicationInsightsTelemetryProcessor to support Azure Storage BLOB errors.
- JSON serializer options can be defined in options now and are automatically applied at startup.
- Improved automatic service registration.
- New callbacks in options allow reactions to model mappings in a finer level.
- Moved DefaultPolicy from global options to AuthOptions.
- Added new Auth-Option "AzureAdGroupClaims" which allows to specifiy custom auth-policies for AD-group-membership checks on controllers.
- Authorization now provides callbacks before and after activation.
- Controller base classes now take service provider and use InjectionHelper to resolve DI
- Added new base controller
- Startup now checks if the environment variable ASPNETCORE_ENVIRONMENT is defined and throws exception if not.
- Added package readme