OpenApiRouteHandlerBuilderExtensions.Produces Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Перегрузки
Produces(RouteHandlerBuilder, Int32, Type, String, String[]) |
Добавляет к IProducesResponseTypeMetadataMetadata для всех конечных точек, созданных . |
Produces<TResponse>(RouteHandlerBuilder, Int32, String, String[]) |
Добавляет к IProducesResponseTypeMetadataMetadata для всех конечных точек, созданных . |
Produces(RouteHandlerBuilder, Int32, Type, String, String[])
- Исходный код:
- OpenApiRouteHandlerBuilderExtensions.cs
Добавляет к IProducesResponseTypeMetadataMetadata для всех конечных точек, созданных .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
Параметры
- builder
- RouteHandlerBuilder
- statusCode
- Int32
Код состояния ответа.
- responseType
- Type
Тип ответа. Значение по умолчанию — NULL.
- contentType
- String
Тип контента ответа. По умолчанию используется значение "application/json", если responseType не равно NULL, в противном случае значение по умолчанию равно NULL.
- additionalContentTypes
- String[]
Дополнительные типы содержимого ответа, которые конечная точка создает для предоставленного кода состояния.
Возвращаемое значение
Объект , RouteHandlerBuilder который можно использовать для дальнейшей настройки конечной точки.
Применяется к
Produces<TResponse>(RouteHandlerBuilder, Int32, String, String[])
- Исходный код:
- OpenApiRouteHandlerBuilderExtensions.cs
Добавляет к IProducesResponseTypeMetadataMetadata для всех конечных точек, созданных .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
Параметры типа
- TResponse
Тип ответа.
Параметры
- builder
- RouteHandlerBuilder
- statusCode
- Int32
Код состояния ответа. По умолчанию — Status200OK.
- contentType
- String
Тип контента ответа. Значение по умолчанию — application/json.
- additionalContentTypes
- String[]
Дополнительные типы содержимого ответа, которые конечная точка создает для предоставленного кода состояния.
Возвращаемое значение
Объект , RouteHandlerBuilder который можно использовать для дальнейшей настройки конечной точки.