Namespace Codebelt.Extensions.Swashbuckle.AspNetCore

The Codebelt.Extensions.Swashbuckle.AspNetCore namespace contains types and extension methods that complements the Swashbuckle.AspNetCore namespace by adding new and optimized ways of working with Swagger 2.0 and OpenAPI 3.0.

Availability: .NET 10 and .NET 9

Complements: Swashbuckle.AspNetCore 🔗 Related: Codebelt.Extensions.Asp.Versioning 📘

Extension Methods

Type	Ext	Methods
IServiceCollection	⬇️	AddRestfulSwagger
SwaggerGenOptions	⬇️	AddUserAgent, AddXApiKeySecurity, AddJwtBearerSecurity, AddBasicAuthenticationSecurity
XPathDocument	⬇️	AddByType, AddByAssembly, AddByFilename

Classes

ConfigureSwaggerGenOptions

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

ConfigureSwaggerUIOptions

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

DocumentFilter

Represents the base class of an IDocumentFilter implementation.

DocumentFilter<T>

Represents a configurable base class of an IDocumentFilter implementation.

OpenApiInfoOptions

Represents a proxy for configuring an Open API Info Object that provides metadata about an Open API endpoint.

OperationFilter

Represents the base class of an IOperationFilter implementation.

OperationFilter<T>

Represents a configurable base class of an IOperationFilter implementation.

RestfulSwaggerOptions

Provides programmatic configuration for the AddRestfulSwagger(IServiceCollection, Action<RestfulSwaggerOptions>) method.

ServiceCollectionExtensions

Extension methods for the IServiceCollection interface.

SwaggerGenOptionsExtensions

Extension methods for the SwaggerGenOptions class.

UserAgentDocumentFilter

Provides a User-Agent field to the generated OpenApiDocument.

UserAgentDocumentOptions

Provides programmatic configuration for the UserAgentDocumentFilter class.

XPathDocumentExtensions

Extension methods for the XPathDocument class.