Class ConfigureSwaggerOptions

Namespace

FoundationaLLM.Common.OpenAPI

Assembly

FoundationaLLM.Common.dll

Configures the Swagger generation options.

public class ConfigureSwaggerOptions : IConfigureOptions<SwaggerGenOptions>

Inheritance

object

ConfigureSwaggerOptions

Implements

IConfigureOptions<SwaggerGenOptions>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ObjectExtensions.GetPropertyValues(object, List<string>)

Remarks

This allows API versioning to define a Swagger document per API version after the Asp.Versioning.ApiExplorer.IApiVersionDescriptionProvider service has been resolved from the service container.

Constructors

ConfigureSwaggerOptions(IApiVersionDescriptionProvider)

Initializes a new instance of the ConfigureSwaggerOptions class.

public ConfigureSwaggerOptions(IApiVersionDescriptionProvider provider)

Parameters

provider IApiVersionDescriptionProvider

The provider used to generate Swagger documents.

Methods

Configure(SwaggerGenOptions)

Invoked to configure a SwaggerGenOptions instance.

public void Configure(SwaggerGenOptions options)

Parameters

options SwaggerGenOptions

The options instance to configure.