devdeer.Libraries.AspNetCore.RestApi 14.3.0

.NET 6.0 
dotnet add package devdeer.Libraries.AspNetCore.RestApi --version 14.3.0
NuGet\Install-Package devdeer.Libraries.AspNetCore.RestApi -Version 14.3.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="devdeer.Libraries.AspNetCore.RestApi" Version="14.3.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add devdeer.Libraries.AspNetCore.RestApi --version 14.3.0
#r "nuget: devdeer.Libraries.AspNetCore.RestApi, 14.3.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 devdeer.Libraries.AspNetCore.RestApi as a Cake Addin
#addin nuget:?package=devdeer.Libraries.AspNetCore.RestApi&version=14.3.0

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

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 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. 
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
14.3.0 107 3/21/2024
14.2.0 177 3/11/2024
14.1.1 85 3/9/2024
14.1.0 75 3/9/2024
14.0.1 301 2/18/2024
14.0.0 458 1/20/2024
13.0.5 81 1/18/2024
13.0.4 304 12/25/2023
13.0.3 87 12/25/2023
13.0.2 217 12/11/2023
13.0.0 105 12/10/2023
12.7.5 245 11/9/2023
12.7.4 112 11/9/2023
12.7.3 159 10/29/2023
12.7.2 111 10/29/2023
12.7.1 210 9/27/2023
12.7.0 139 9/16/2023
12.6.4 143 9/14/2023
12.6.2 156 9/8/2023
12.6.1 134 9/7/2023
12.6.0 119 9/6/2023
12.5.0 458 8/15/2023
12.4.1 109 8/15/2023
12.4.0 135 8/15/2023
12.3.0 557 5/30/2023
12.2.1 136 5/29/2023
12.2.0 170 5/24/2023
12.1.0 152 5/24/2023
12.0.0 167 5/24/2023
11.0.5 662 5/23/2023
11.0.4 143 5/23/2023
11.0.3 138 5/23/2023
11.0.2 191 5/21/2023
11.0.1 152 5/21/2023
11.0.0 153 5/21/2023
10.6.0 158 5/21/2023
10.5.13 935 4/12/2023
10.5.12 204 4/12/2023
10.5.11 197 4/12/2023
10.5.10 423 4/12/2023
10.5.9 232 4/6/2023
10.5.8 381 3/14/2023
10.5.7 227 3/14/2023
10.5.6 620 3/11/2023
10.5.5 660 1/13/2023
10.5.4 521 1/10/2023
10.5.3 321 1/4/2023
10.5.2 302 1/3/2023
10.5.1 456 12/29/2022
10.5.0 537 12/29/2022
10.4.2 318 12/29/2022
10.4.0 635 12/23/2022
10.2.24 1,357 10/19/2022
10.2.23 414 10/19/2022
10.2.22 370 10/18/2022
10.2.21 377 10/17/2022
10.2.20 388 10/17/2022
10.2.19 402 10/17/2022
10.2.18 627 9/13/2022
10.2.17 1,183 9/13/2022
10.2.16 832 9/7/2022
10.2.15 681 9/6/2022
10.2.14 991 9/6/2022
10.2.13 441 9/6/2022
10.2.12 670 9/6/2022
10.2.11 653 9/6/2022
10.2.10 627 9/6/2022
10.2.9 841 9/5/2022
10.2.8 547 8/15/2022
10.2.7 481 8/13/2022
10.2.6 627 8/5/2022
10.2.5 619 7/19/2022
10.2.4 1,236 5/16/2022
10.2.3 540 5/16/2022
10.2.2 1,420 3/20/2022
10.2.0 612 3/20/2022
10.1.1 619 3/18/2022
10.1.0 590 3/14/2022
10.0.0 637 3/1/2022
9.0.4 637 2/28/2022
9.0.3 1,764 1/24/2022
9.0.2 532 12/22/2021
9.0.1 365 12/22/2021
9.0.0 364 12/22/2021
8.0.5 928 12/1/2021
8.0.3 1,008 8/14/2021
8.0.2 534 8/14/2021
8.0.1 622 8/14/2021
8.0.0 431 8/9/2021
7.0.13 1,343 7/12/2021
7.0.12 850 6/9/2021
7.0.11 1,156 5/1/2021
7.0.10 997 5/1/2021
1.4.0 699 8/25/2020

- Sensitive information now sanitized in Application Insights.
           - New `ApplicationInsights:SanitazationHeadersToAdd` option allows to add header keys to sanitize in AppInsights.