OpenApiRouteHandlerBuilderExtensions Class

Reference

Definition

Namespace:: Microsoft.AspNetCore.Http

Assembly:: Microsoft.AspNetCore.Routing.dll

Package:: Microsoft.AspNetCore.App.Ref v6.0.6

Package:: Microsoft.AspNetCore.App.Ref v7.0.0-preview.5.22303.8

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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`.
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`.
ProducesValidationProblem(RouteHandlerBuilder, Int32, String)	Adds an IProducesResponseTypeMetadata with a HttpValidationProblemDetails type to Metadata for all endpoints produced by `builder`.
WithDescription(RouteHandlerBuilder, String)	Adds IEndpointDescriptionMetadata to Metadata for all endpoints produced by `builder`.
WithSummary(RouteHandlerBuilder, 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`.

Applies to