Skip to content

Latest commit

 

History

History
134 lines (102 loc) · 4.87 KB

File metadata and controls

134 lines (102 loc) · 4.87 KB

Atc.Rest.Extended.Filters


ApiVersionDocumentFilter

Swagger Swashbuckle.AspNetCore.SwaggerGen.IDocumentFilter that removes API version parameters from the OpenAPI document. Cleans up version parameters that appear in headers and query strings to avoid duplication.

public class ApiVersionDocumentFilter : IDocumentFilter

Methods

Apply

void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)

Summary: Applies the filter to remove API version parameters from the Swagger document.

Parameters:
     swaggerDoc  -  The to modify.
     context  -  The containing API descriptions.


ApiVersionOperationFilter

Swagger Swashbuckle.AspNetCore.SwaggerGen.IOperationFilter that configures API version parameters in OpenAPI operations. Sets default values and enumerates available versions for version parameters.

public class ApiVersionOperationFilter : IOperationFilter

Methods

Apply

void Apply(OpenApiOperation operation, OperationFilterContext context)

Summary: Applies the filter to configure API version parameters in the operation.

Parameters:
     operation  -  The to modify.
     context  -  The containing operation metadata.


AuthorizeResponseOperationFilter

Swagger Swashbuckle.AspNetCore.SwaggerGen.IOperationFilter that adds 401 and 403 response codes to operations requiring authorization. Automatically documents authentication and authorization responses for secured endpoints.

public class AuthorizeResponseOperationFilter : IOperationFilter

Methods

Apply

void Apply(OpenApiOperation operation, OperationFilterContext context)

Summary: Applies the filter to add authorization response codes to the operation.

Parameters:
     operation  -  The to modify.
     context  -  The containing operation metadata.


DefaultResponseOperationFilter

Swagger Swashbuckle.AspNetCore.SwaggerGen.IOperationFilter that adds a default response with Microsoft.AspNetCore.Mvc.ProblemDetails to operations. Ensures all operations have a documented error response format.

Remarks: Reference: domaindrivendev/Swashbuckle.AspNetCore#1278.

public class DefaultResponseOperationFilter : IOperationFilter

Methods

Apply

void Apply(OpenApiOperation operation, OperationFilterContext context)

Summary: Applies the filter to add a default response to the operation if not already present.

Parameters:
     operation  -  The to modify.
     context  -  The containing operation metadata.


SecurityRequirementsOperationFilter

Swagger Swashbuckle.AspNetCore.SwaggerGen.IOperationFilter that adds OAuth2 security requirements to operations requiring authorization. Maps authorization policies to OAuth2 scopes and documents security requirements in the OpenAPI specification.

public class SecurityRequirementsOperationFilter : IOperationFilter

Methods

Apply

void Apply(OpenApiOperation operation, OperationFilterContext context)

Summary: Applies the filter to add security requirements to the operation.

Parameters:
     operation  -  The to modify.
     context  -  The containing operation metadata.


SwaggerEnumDescriptionsDocumentFilter

Swagger Swashbuckle.AspNetCore.SwaggerGen.IDocumentFilter that enriches enum types with descriptions showing their numeric values and names. Adds detailed enum value mappings to both schema definitions and operation parameters.

public class SwaggerEnumDescriptionsDocumentFilter : IDocumentFilter

Methods

Apply

void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)

Summary: Applies the filter to add enum descriptions to the Swagger document.

Parameters:
     swaggerDoc  -  The to modify.
     context  -  The containing API descriptions.


Generated by MarkdownCodeDoc version 1.2