HUMANiT.Azure 1.2.0-rc-3041

HUMANiT Azure

This package provides logic that we miss in .NET for Azure, but that find valuable for our own daily software development. -- the people of HUMANiT

Features

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

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

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

Contact

• Twitter -- stay in touch (@HUMANiTnz)
• Facebook -- message with us (@HUMANiTnz)
• support@humanit.nz -- contact us via email

License

MIT -- free software, hell yeah 🤩

Quickstart

Classes that inherit from AzureBase can use this package's features:

public class YourClass : AzureBase<YourClass> { .. }

Logging

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

To use logging features, you must call one of the provided constructors:

// call this constructor if you have a logger handy
public YourClass(ILogger logger) : base(logger) { .. }

// call this constructor if you have a logger factory handy
public YourClass(ILoggerFactory loggerFactory) : base(loggerFactory) { .. }

Logging is enabled by default. You can control the default by defining its state during contruction. All constructors have an optional parameter enableLogging:

public YourClass(ILogger logger, bool enableLogging) : base(logger, enableLogging) { .. }

Logging can be enabled and disabled during runtime using the methods EnableLogging() and DisableLogging().

You can check the logging status during runtime by calling IsLoggingEnabled and IsLoggingDisabled.

You can log a message or exception anywhere in your class using 6 log levels. For all log levels, there are multiple overloaded named methods available: LogDebug(), LogTrace(), LogInformation(), LogWarning(), LogError(), and LogCritical().

You can log entering a method by calling LogMethodCall():

public void YourMethod() {
    LogMethodCall(nameof(YourClass), nameof(YourMethod));
    ..
}

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.

Quickstart guidance will come.