OpenApiRouteHandlerBuilderExtensions.Produces Método

Definição

Namespace:

Microsoft.AspNetCore.Http

Assembly:

Microsoft.AspNetCore.Routing.dll

Pacote:

Microsoft.AspNetCore.App.Ref v8.0.0

Sobrecargas

Produces(RouteHandlerBuilder, Int32, Type, String, String[])	Adiciona um IProducesResponseTypeMetadata a para Metadata todos os pontos de extremidade produzidos por builder.
Produces<TResponse>(RouteHandlerBuilder, Int32, String, String[])	Adiciona um IProducesResponseTypeMetadata a para Metadata todos os pontos de extremidade produzidos por builder.

Produces(RouteHandlerBuilder, Int32, Type, String, String[])

Origem:

OpenApiRouteHandlerBuilderExtensions.cs

Adiciona um IProducesResponseTypeMetadata a para Metadata todos os pontos de extremidade produzidos por builder.

public static Microsoft.AspNetCore.Builder.RouteHandlerBuilder Produces (this Microsoft.AspNetCore.Builder.RouteHandlerBuilder builder, int statusCode, Type? responseType = default, string? contentType = default, params string[] additionalContentTypes);

static member Produces : Microsoft.AspNetCore.Builder.RouteHandlerBuilder * int * Type * string * string[] -> Microsoft.AspNetCore.Builder.RouteHandlerBuilder

<Extension()>
Public Function Produces (builder As RouteHandlerBuilder, statusCode As Integer, Optional responseType As Type = Nothing, Optional contentType As String = Nothing, ParamArray additionalContentTypes As String()) As RouteHandlerBuilder

Parâmetros

builder

RouteHandlerBuilder

O RouteHandlerBuilder.

statusCode

Int32

A resposta status código.

responseType

Type

O tipo da resposta. O padrão é nulo.

contentType

String

O tipo de conteúdo de resposta. O padrão será "application/json" se responseType não for nulo, caso contrário, o padrão será nulo.

additionalContentTypes

String[]

Tipos de conteúdo de resposta adicionais que o ponto de extremidade produz para o código de status fornecido.

Retornos

RouteHandlerBuilder

Um RouteHandlerBuilder que pode ser usado para personalizar ainda mais o ponto de extremidade.

Produces<TResponse>(RouteHandlerBuilder, Int32, String, String[])

Origem:

OpenApiRouteHandlerBuilderExtensions.cs

Adiciona um IProducesResponseTypeMetadata a para Metadata todos os pontos de extremidade produzidos por builder.

public static Microsoft.AspNetCore.Builder.RouteHandlerBuilder Produces<TResponse> (this Microsoft.AspNetCore.Builder.RouteHandlerBuilder builder, int statusCode = 200, string? contentType = default, params string[] additionalContentTypes);

static member Produces : Microsoft.AspNetCore.Builder.RouteHandlerBuilder * int * string * string[] -> Microsoft.AspNetCore.Builder.RouteHandlerBuilder

<Extension()>
Public Function Produces(Of TResponse) (builder As RouteHandlerBuilder, Optional statusCode As Integer = 200, Optional contentType As String = Nothing, ParamArray additionalContentTypes As String()) As RouteHandlerBuilder

Parâmetros de tipo

TResponse

O tipo da resposta.

Parâmetros

builder

RouteHandlerBuilder

O RouteHandlerBuilder.

statusCode

Int32

A resposta status código. Assume o padrão de Status200OK.

contentType

String

O tipo de conteúdo de resposta. O padrão é "application/json".

additionalContentTypes

String[]

Tipos de conteúdo de resposta adicionais que o ponto de extremidade produz para o código de status fornecido.

Retornos

RouteHandlerBuilder

Um RouteHandlerBuilder que pode ser usado para personalizar ainda mais o ponto de extremidade.