HUMANiT.Azure 2.0.3

HUMANiT Azure

Features

• API Proxy: GET, PUT, POST, PATCH, and DELETE commands to proxy a call directly to a RESTful API. Built-in secondary proxy. Raw calls. Azure Functions obfuscation keys.
• Simple API Proxy: Provides access to a RESTful API via type-safe resource types and pre-defines expected responses. Allways returns a result; never throws an exception. Built-in secondary proxy. Raw calls. Azure Functions obfuscation keys.
• Domain API Proxy: Provides access to a RESTful API via immutable type-safe domain objects and pre-defines expected responses. Allways returns a result; never throws an exception. Built-in secondary proxy. Raw calls. Azure Functions obfuscation keys.
• HTTP Methods: Constants for all used HTTP methods as per standard HTTP protocols 1.1, 2, and 3.
• Media Types: Constants for most commonly used media types.
• HTTP StatusCode Extensions: Extension methods for easier use of System.Net.HttpStatusCode.
• Logging: Simplified logging that is always available and can be enabled/disabled during runtime.

Version 2.0 (Upgrade from 1.2)

• Breaking: Explicit .NET 6 target framework removed. Use .NET 8 instead.
• New: SimpleApiProxy offers 3 types of patch type configuration.
• Improved: Inline documentation.
• Obsolete: HUMANiT.Azure.AzureBase deprecated. Use HUMANiT.Logging.Logable instead (see HUMANiT Core package).

Contact

This package contains features which we require for our own software; therefore, some features are highly custom. If you require a fix, an enhancement, or a more configurable solution, please contact us: support@humanit.nz.

License

MIT -- free software, hell yeah 🤩

Quickstart

API Proxy

GET, PUT, POST, PATCH, and DELETE commands to proxy a call directly to a RESTful API. Built-in secondary proxy. Raw calls. Obfuscation keys.

Quickstart guidance will come.

Simple API Proxy

Provides access to a RESTful API via type-safe resource types and pre-defines expected responses. Allways returns a result; never throws an exception. Built-in secondary proxy. Raw calls. Azure Functions obfuscation keys.

Quickstart guidance will come.

Domain API Proxy

Provides access to a RESTful API via immutable type-safe domain objects and pre-defines expected responses. Allways returns a result; never throws an exception. Built-in secondary proxy. Raw calls. Azure Functions obfuscation keys.

Quickstart guidance will come.

HTTP Methods

Constants for all used HTTP methods as per standard HTTP protocols 1.1, 2, and 3.

Quickstart guidance will come.

Media Types

Constants for most commonly used media types.

Quickstart guidance will come.

HTTP StatusCode Extensions

Extension methods for easier use of System.Net.HttpStatusCode.

Located in namespace HUMANiT.Azure.Extensions.

The method System.Net.HttpStatusCode.RenderAsText() renders an HTTP status code as human-readable text, practical for logging, tracing, auditing, and other forms of displaying an error to a human. The status code 204, for instance, is rendered as "201 Created", and the status code 503 is rendered as "503 ServiceUnavailable".

The optional method parameter splitName defines readability. Default is false. If set to true, it splits the descriptive names. For instance, the status code 204 is rendered as "201 Created", and the status code 503 is rendered as "503 Service Unavailable". Example:

System.WriteLine(System.Net.HttpStatusCode.NotAcceptable.RenderAsText(true));
// output: 406 Not Acceptable

Logging (obsolete)

Simplified logging that is always available and can be enabled/disabled during runtime.

Located in namespace HUMANiT.Azure.

HUMANiT.Azure.AzureBase declared obsolete. Use HUMANiT.Logging.Logable instead; see HUMANiT Core package.