Class DocumentFilter

Namespace

Codebelt.Extensions.Swashbuckle.AspNetCore

Assembly

Codebelt.Extensions.Swashbuckle.AspNetCore.dll

Represents the base class of an Swashbuckle.AspNetCore.SwaggerGen.IDocumentFilter implementation.

public abstract class DocumentFilter : IDocumentFilter

Inheritance

Object

DocumentFilter

Implements

IDocumentFilter

Derived

DocumentFilter<T>

Remarks

https://github.com/domaindrivendev/Swashbuckle.AspNetCore#document-filters

Constructors

DocumentFilter()

Initializes a new instance of the DocumentFilter class.

protected DocumentFilter()

Methods

Apply(OpenApiDocument, DocumentFilterContext)

Applies post-processing to the swaggerDoc.

public abstract void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)

Parameters

swaggerDoc OpenApiDocument

The Microsoft.OpenApi.Models.OpenApiDocument to modify.

context DocumentFilterContext

The Swashbuckle.AspNetCore.SwaggerGen.DocumentFilterContext that provides additional context.

Remarks

Once an Microsoft.OpenApi.Models.OpenApiDocument has been generated you have full control to modify the document however you see fit.

See Also

IDocumentFilter