https://github.com/samhammerag/samhammer.web.common

Common logic you can use in your for .NET Core web projects
https://github.com/samhammerag/samhammer.web.common

net-core-project-lib

Last synced: about 1 month ago
JSON representation

Common logic you can use in your for .NET Core web projects

• Host: GitHub
• URL: https://github.com/samhammerag/samhammer.web.common
• Owner: SamhammerAG
• Created: 2020-01-22T09:45:46.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-03-08T11:39:11.000Z (10 months ago)
• Last Synced: 2024-08-09T12:27:43.825Z (5 months ago)
• Topics: net-core-project-lib
• Language: C#
• Homepage:
• Size: 43 KB
• Stars: 0
• Watchers: 5
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## 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:

```csharp

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:

```csharp

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:

```csharp

.AddUnsignedHttpClient()

```

Afterwards you can create a specific http client by using the following code:

```csharp

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:

```csharp

.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:

```csharp

app.UseDefaultExceptionHandler();

```

## Contribute

#### How to publish package

- Create a tag and let the github action do the publishing for you