Class ConfigureSwaggerUIOptions

Namespace

Codebelt.Extensions.Swashbuckle.AspNetCore

Assembly

Codebelt.Extensions.Swashbuckle.AspNetCore.dll

Represents something that configures the SwaggerUIOptions type. Note: These are run before all IPostConfigureOptions<TOptions>.

public class ConfigureSwaggerUIOptions : IConfigureOptions<SwaggerUIOptions>

Inheritance

object

ConfigureSwaggerUIOptions

Implements

IConfigureOptions<SwaggerUIOptions>

Examples

Automatically configure Swagger UI options through the ASP.NET Core Options pattern. When you call AddRestfulSwagger, a ConfigureSwaggerUIOptions instance is automatically registered as an IConfigureOptions<SwaggerUIOptions> implementation and applied by the framework. This example shows how the type is used internally: it retrieves the registered ConfigureSwaggerUIOptions from the service provider and demonstrates that it implements the configuration interface:

using System;
using Codebelt.Extensions.Swashbuckle.AspNetCore;
using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Options;
using Swashbuckle.AspNetCore.SwaggerUI;

namespace MySwaggerExample;

public class Program
{
    public static void Main(string[] args)
    {
        var builder = WebApplication.CreateBuilder(args);
        builder.Services.AddControllers();
        builder.Services.AddEndpointsApiExplorer();

        // Register RestfulSwagger which internally uses ConfigureSwaggerUIOptions
        builder.Services.AddRestfulSwagger();

        var app = builder.Build();

        if (string.Equals(app.Environment.EnvironmentName, "Development", StringComparison.OrdinalIgnoreCase))
        {
            app.UseSwagger();
            app.UseSwaggerUI();

            // ConfigureSwaggerUIOptions is automatically registered and applied by the framework
            // Retrieve the configuration service to verify ConfigureSwaggerUIOptions is present
            var configureService = app.Services.GetService(typeof(IConfigureOptions<SwaggerUIOptions>));
            if (configureService is ConfigureSwaggerUIOptions configureUI)
            {
                // ConfigureSwaggerUIOptions has been registered and will be invoked by the Options system
            }
        }

        app.MapControllers();
        app.Run();
    }
}

Constructors

ConfigureSwaggerUIOptions(IApiVersionDescriptionProvider)

Initializes a new instance of the ConfigureSwaggerUIOptions class.

public ConfigureSwaggerUIOptions(IApiVersionDescriptionProvider provider)

Parameters

provider IApiVersionDescriptionProvider

The behavior of a provider that discovers and describes API version information within an application.

Methods

Configure(SwaggerUIOptions)

Invoked to configure a SwaggerUIOptions instance.

public void Configure(SwaggerUIOptions options)

Parameters

options SwaggerUIOptions

The options instance to configure.

See Also

IConfigureOptions<TOptions>