OpenApiRouteHandlerBuilderExtensions Class

Definition

Namespace:

Microsoft.AspNetCore.Http

Assembly:

Microsoft.AspNetCore.Routing.dll

Package:

Microsoft.AspNetCore.App.Ref v9.0.0

Extension methods for adding Metadata that is meant to be consumed by OpenAPI libraries.

public static class OpenApiRouteHandlerBuilderExtensions

type OpenApiRouteHandlerBuilderExtensions = class

Public Module OpenApiRouteHandlerBuilderExtensions

Inheritance

Object

OpenApiRouteHandlerBuilderExtensions

Methods

Accepts(RouteHandlerBuilder, Type, Boolean, String, String[])	Adds IAcceptsMetadata to Metadata for all endpoints produced by builder.
Accepts(RouteHandlerBuilder, Type, String, String[])	Adds IAcceptsMetadata to Metadata for all endpoints produced by builder.
Accepts<TRequest>(RouteHandlerBuilder, Boolean, String, String[])	Adds IAcceptsMetadata to Metadata for all endpoints produced by builder.
Accepts<TRequest>(RouteHandlerBuilder, String, String[])	Adds IAcceptsMetadata to Metadata for all endpoints produced by builder.
ExcludeFromDescription(RouteHandlerBuilder)	Adds the IExcludeFromDescriptionMetadata to Metadata for all endpoints produced by builder.
ExcludeFromDescription<TBuilder>(TBuilder)	Adds the IExcludeFromDescriptionMetadata to Metadata for all endpoints produced by builder.
Produces(RouteHandlerBuilder, Int32, Type, String, String[])	Adds an IProducesResponseTypeMetadata to Metadata for all endpoints produced by builder.
Produces<TResponse>(RouteHandlerBuilder, Int32, String, String[])	Adds an IProducesResponseTypeMetadata to Metadata for all endpoints produced by builder.
ProducesProblem(RouteHandlerBuilder, Int32, String)	Adds an IProducesResponseTypeMetadata with a ProblemDetails type to Metadata for all endpoints produced by builder.
ProducesProblem<TBuilder>(TBuilder, Int32, String)	Adds an IProducesResponseTypeMetadata with a ProblemDetails type to Metadata for all endpoints produced by builder.
ProducesValidationProblem(RouteHandlerBuilder, Int32, String)	Adds an IProducesResponseTypeMetadata with a HttpValidationProblemDetails type to Metadata for all endpoints produced by builder.
ProducesValidationProblem<TBuilder>(TBuilder, Int32, String)	Adds an IProducesResponseTypeMetadata with a HttpValidationProblemDetails type to Metadata for all endpoints produced by builder.
WithDescription<TBuilder>(TBuilder, String)	Adds IEndpointDescriptionMetadata to Metadata for all endpoints produced by builder.
WithSummary<TBuilder>(TBuilder, String)	Adds IEndpointSummaryMetadata to Metadata for all endpoints produced by builder.
WithTags(RouteHandlerBuilder, String[])	Adds the ITagsMetadata to Metadata for all endpoints produced by builder.
WithTags<TBuilder>(TBuilder, String[])	Adds the ITagsMetadata to Metadata for all endpoints produced by builder.