Samhammer.Web.Common
8.0.0
dotnet add package Samhammer.Web.Common --version 8.0.0
NuGet\Install-Package Samhammer.Web.Common -Version 8.0.0
<PackageReference Include="Samhammer.Web.Common" Version="8.0.0" />
paket add Samhammer.Web.Common --version 8.0.0
#r "nuget: Samhammer.Web.Common, 8.0.0"
// Install Samhammer.Web.Common as a Cake Addin #addin nuget:?package=Samhammer.Web.Common&version=8.0.0 // Install Samhammer.Web.Common as a Cake Tool #tool nuget:?package=Samhammer.Web.Common&version=8.0.0
Samhammer.Web.Common
This is a collection of tools to make creation of web projects simpler. It provides functionality that can be used in every web API project that is built with ASP.NET Core.
How to add this to your project:
- reference this package to your project: https://www.nuget.org/packages/Samhammer.Web.Common/
Available Features
Version endpoint
If it is enabled you get an endpoint "/version" and "/api/version" that returns a json with the version number of the entry assembly and the hosting environment.
Add the following to the method Configure of your Startup.cs to enable it:
app.UseVersion();
Ping endpoint
If it is enabled you get an endpoint "/ping" that just returns "OK".
Add the following to the method Configure of your Startup.cs to enable it:
app.UsePing();
HttpClient with self signed certificates
If it is enabled you get an http client that also accepts untrusted certificates.
Add the following extension to your IWebHostBuilder in Program.cs:
.AddUnsignedHttpClient()
Afterwards you can create a specific http client by using the following code:
var client = HttpClientFactory.CreateClient(HttpClientNames.UnsignedHttpClient);
Furthermore you can allow self signed certs for an existing http client with the following block added to your IHttpClientBuilder:
.AddAllowUnsignedPrimaryHandler()
Exception handling
If you don't want to get error messages in your json api you can enable a default exception handler.
Add the following to the method Configure of your Startup.cs to enable it:
app.UseDefaultExceptionHandler();
Contribute
How to publish package
- Create a tag and let the github action do the publishing for you
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | 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. |
-
net8.0
- No dependencies.
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.