Class ConfigureSwaggerGenOptions

Namespace

Codebelt.Extensions.Swashbuckle.AspNetCore

Assembly

Codebelt.Extensions.Swashbuckle.AspNetCore.dll

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

public class ConfigureSwaggerGenOptions : Configurable<RestfulSwaggerOptions>, IConfigurable<RestfulSwaggerOptions>, IConfigureOptions<SwaggerGenOptions>

Inheritance

object

Configurable<RestfulSwaggerOptions>

ConfigureSwaggerGenOptions

Implements

IConfigurable<RestfulSwaggerOptions>

IConfigureOptions<SwaggerGenOptions>

Inherited Members

Configurable<RestfulSwaggerOptions>.Options

Examples

Automatically configure Swagger generation options through the ASP.NET Core Options pattern. When you call AddRestfulSwagger, a ConfigureSwaggerGenOptions instance is automatically registered as an IConfigureOptions<SwaggerGenOptions> implementation and applied by the framework. This example shows how the type is used internally: it retrieves the registered ConfigureSwaggerGenOptions 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.SwaggerGen;

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 ConfigureSwaggerGenOptions
        builder.Services.AddRestfulSwagger(options =>
        {
            options.OpenApiInfo.Title = "My API";
        });

        var app = builder.Build();

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

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

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

Constructors

ConfigureSwaggerGenOptions(IApiVersionDescriptionProvider, IOptions<RestfulSwaggerOptions>)

Initializes a new instance of the ConfigureSwaggerGenOptions class.

public ConfigureSwaggerGenOptions(IApiVersionDescriptionProvider provider, IOptions<RestfulSwaggerOptions> restfulSwaggerOptions)

Parameters

provider IApiVersionDescriptionProvider

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

restfulSwaggerOptions IOptions<RestfulSwaggerOptions>

The options for configuring the SwaggerGenOptions.

Methods

Configure(SwaggerGenOptions)

Invoked to configure a SwaggerGenOptions instance.

public void Configure(SwaggerGenOptions options)

Parameters

options SwaggerGenOptions

The options instance to configure.

See Also

IConfigureOptions<TOptions>