Class ServiceCollectionExtensions

Namespace

Codebelt.Extensions.AspNetCore.Text.Yaml.Formatters

Assembly

Codebelt.Extensions.AspNetCore.Text.Yaml.dll

Extension methods for the IServiceCollection interface.

public static class ServiceCollectionExtensions

Inheritance

object

ServiceCollectionExtensions

Examples

This example demonstrates how to configure YAML formatter options and add an exception response formatter to an ASP.NET Core application using service collection extensions. It shows the setup workflow: creating a web application builder, registering YAML formatter options with custom sensitivity settings through AddYamlFormatterOptions, adding an exception response formatter through AddYamlExceptionResponseFormatter with different sensitivity settings, and then building the app with a route that throws an exception to test the error handling. The observable outcome is that the application is configured to handle exceptions by serializing them as YAML responses with the specified detail levels.

using System;
using Codebelt.Extensions.AspNetCore.Text.Yaml.Formatters;
using Codebelt.Extensions.YamlDotNet.Formatters;
using Cuemon.AspNetCore.Diagnostics;
using Cuemon.Diagnostics;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.DependencyInjection;

namespace ExampleNamespace;

class Program
{
    static void Main()
    {
        var builder = WebApplication.CreateBuilder();
        
        // Add YAML formatter options with custom sensitivity settings
        builder.Services.AddYamlFormatterOptions(options =>
        {
            options.SensitivityDetails = FaultSensitivityDetails.FailureWithStackTrace | FaultSensitivityDetails.FailureWithData;
        });
        
        // Add exception response formatter using YAML
        builder.Services.AddYamlExceptionResponseFormatter(options =>
        {
            options.SensitivityDetails = FaultSensitivityDetails.All;
        });
        
        var app = builder.Build();
        
        app.MapGet("/error", (HttpContext context) => 
        {
            throw new InvalidOperationException("Example exception");
        });
        
        app.MapGet("/", async (HttpContext context) =>
        {
            await context.Response.WriteAsync("Hello World");
        });
        
        app.Run();
    }
}

Methods

AddYamlExceptionResponseFormatter(IServiceCollection, Action<YamlFormatterOptions>)

Adds an IHttpExceptionDescriptorResponseFormatter that uses YamlFormatter as engine of serialization to the specified list of services.

public static IServiceCollection AddYamlExceptionResponseFormatter(this IServiceCollection services, Action<YamlFormatterOptions> setup = null)

Parameters

services IServiceCollection

The IServiceCollection to extend.

setup Action<YamlFormatterOptions>

The YamlFormatterOptions which may be configured.

Returns

IServiceCollection

A reference to services so that additional calls can be chained.

Remarks

Configuration of the YamlFormatter is done through a call to GetService<T>(IServiceProvider) retrieving an IOptions<TOptions> implementation of YamlFormatterOptions.

Exceptions

ArgumentNullException

services cannot be null

AddYamlFormatterOptions(IServiceCollection, Action<YamlFormatterOptions>)

Adds configuration of YamlFormatterOptions for the application.

public static IServiceCollection AddYamlFormatterOptions(this IServiceCollection services, Action<YamlFormatterOptions> setup = null)

Parameters

services IServiceCollection

The IServiceCollection to extend.

setup Action<YamlFormatterOptions>

The YamlFormatterOptions which may be configured.

Returns

IServiceCollection

A reference to services so that additional configuration calls can be chained.

Exceptions

ArgumentNullException

services cannot be null.