OpenApiRouteHandlerBuilderExtensions.ProducesProblem Method

  • 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.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.0
Package:
Microsoft.AspNetCore.App.Ref v9.0.0-rc.1.24452.1

Overloads

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.

ProducesProblem(RouteHandlerBuilder, Int32, String)

Source:
OpenApiRouteHandlerBuilderExtensions.cs

Adds an IProducesResponseTypeMetadata with a ProblemDetails type to Metadata for all endpoints produced by builder.

public static Microsoft.AspNetCore.Builder.RouteHandlerBuilder ProducesProblem (this Microsoft.AspNetCore.Builder.RouteHandlerBuilder builder, int statusCode, string? contentType = default);
static member ProducesProblem : Microsoft.AspNetCore.Builder.RouteHandlerBuilder * int * string -> Microsoft.AspNetCore.Builder.RouteHandlerBuilder
<Extension()>
Public Function ProducesProblem (builder As RouteHandlerBuilder, statusCode As Integer, Optional contentType As String = Nothing) As RouteHandlerBuilder

Parameters

builder
RouteHandlerBuilder

The RouteHandlerBuilder.

statusCode
Int32

The response status code.

contentType
String

The response content type. Defaults to "application/problem+json".

Returns

RouteHandlerBuilder

A RouteHandlerBuilder that can be used to further customize the endpoint.

Applies to

ProducesProblem<TBuilder>(TBuilder, Int32, String)

Adds an IProducesResponseTypeMetadata with a ProblemDetails type to Metadata for all endpoints produced by builder.

public static TBuilder ProducesProblem<TBuilder> (this TBuilder builder, int statusCode, string? contentType = default) where TBuilder : Microsoft.AspNetCore.Builder.IEndpointConventionBuilder;
static member ProducesProblem : 'Builder * int * string -> 'Builder (requires 'Builder :> Microsoft.AspNetCore.Builder.IEndpointConventionBuilder)
<Extension()>
Public Function ProducesProblem(Of TBuilder As IEndpointConventionBuilder) (builder As TBuilder, statusCode As Integer, Optional contentType As String = Nothing) As TBuilder

Type Parameters

TBuilder

Parameters

builder
TBuilder

The IEndpointConventionBuilder.

statusCode
Int32

The response status code.

contentType
String

The response content type. Defaults to "application/problem+json".

Returns

TBuilder

A IEndpointConventionBuilder that can be used to further customize the endpoint.

Applies to