Namespace Cuemon.Extensions.Swashbuckle.AspNetCore
The Cuemon.Extensions.Swashbuckle.AspNetCore namespace contains types and extension methods that complements the Swashbuckle.AspNetCore namespace by adding new and optimized ways of working with Open API 3.x.
Availability: .NET 8, .NET 7 and .NET 6
Complements: Swashbuckle.AspNetCore 🔗 Related: Cuemon.Extensions.Asp.Versioning 📘
Extension Methods
| Type | Ext | Methods |
|---|---|---|
| IServiceCollection | ⬇️ | AddRestfulSwagger |
| SwaggerGenOptions | ⬇️ | AddUserAgent, AddXApiKeySecurity, AddJwtBearerSecurity |
| XPathDocument | ⬇️ | AddByType, AddByAssembly, AddByFilename |
Classes
ConfigureSwaggerGenOptions
Represents something that configures the Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenOptions type. Note: These are run before all Microsoft.Extensions.Options.IPostConfigureOptions`1.
ConfigureSwaggerUIOptions
Represents something that configures the Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions type. Note: These are run before all Microsoft.Extensions.Options.IPostConfigureOptions`1.
DocumentFilter
Represents the base class of an Swashbuckle.AspNetCore.SwaggerGen.IDocumentFilter implementation.
DocumentFilter<T>
Represents a configurable base class of an Swashbuckle.AspNetCore.SwaggerGen.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 Swashbuckle.AspNetCore.SwaggerGen.IOperationFilter implementation.
OperationFilter<T>
Represents a configurable base class of an Swashbuckle.AspNetCore.SwaggerGen.IOperationFilter implementation.
RestfulSwaggerOptions
Provides programmatic configuration for the AddRestfulSwagger(IServiceCollection, Action<RestfulSwaggerOptions>) method.
ServiceCollectionExtensions
Extension methods for the Microsoft.Extensions.DependencyInjection.IServiceCollection interface.
SwaggerGenOptionsExtensions
Extension methods for the Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenOptions class.
UserAgentDocumentFilter
Provides a User-Agent field to the generated Microsoft.OpenApi.Models.OpenApiDocument.
UserAgentDocumentOptions
Provides programmatic configuration for the UserAgentDocumentFilter class.
XPathDocumentExtensions
Extension methods for the System.Xml.XPath.XPathDocument class.