Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
OpenApiRouteHandlerBuilderExtensions.ProducesProblem Method
Definition
- Namespace:
- Microsoft.AspNetCore.Http
- Assembly:
- Microsoft.AspNetCore.Routing.dll
- Package:
- Microsoft.AspNetCore.App.Ref v10.0.0
- Package:
- Microsoft.AspNetCore.App.Ref v11.0.0-preview.4.26230.115
- Package:
- Microsoft.AspNetCore.App.Ref v6.0.36
- Package:
- Microsoft.AspNetCore.App.Ref v7.0.5
- Package:
- Microsoft.AspNetCore.App.Ref v8.0.19
- Package:
- Microsoft.AspNetCore.App.Ref v9.0.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.
Overloads
| Name | Description |
|---|---|
| ProducesProblem(RouteHandlerBuilder, Int32, String) |
Adds an IProducesResponseTypeMetadata with a ProblemDetails type
to Metadata for all endpoints produced by |
| ProducesProblem<TBuilder>(TBuilder, Int32, String) |
Adds an IProducesResponseTypeMetadata with a ProblemDetails type
to Metadata for all endpoints produced by |
ProducesProblem(RouteHandlerBuilder, Int32, String)
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 RouteHandlerBuilderParameters
- builder
- RouteHandlerBuilder
The RouteHandlerBuilder.
- statusCode
- Int32
The response status code.
- contentType
- String
The response content type. Defaults to "application/problem+json".
Returns
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 TBuilderType Parameters
- TBuilder
Parameters
- builder
- TBuilder
- statusCode
- Int32
The response status code.
- contentType
- String
The response content type. Defaults to "application/problem+json".
Returns
A IEndpointConventionBuilder that can be used to further customize the endpoint.
Applies to
Feedback
Was this page helpful?