OpenApiRouteHandlerBuilderExtensions.Produces メソッド

定義

名前空間:

Microsoft.AspNetCore.Http

アセンブリ:

Microsoft.AspNetCore.Routing.dll

パッケージ:

Microsoft.AspNetCore.App.Ref v8.0.0

オーバーロード

Produces(RouteHandlerBuilder, Int32, Type, String, String[])	IProducesResponseTypeMetadataによってbuilder生成されるすべてのエンドポイントの に Metadata を追加します。
Produces<TResponse>(RouteHandlerBuilder, Int32, String, String[])	IProducesResponseTypeMetadataによってbuilder生成されるすべてのエンドポイントの に Metadata を追加します。

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

ソース:

OpenApiRouteHandlerBuilderExtensions.cs

IProducesResponseTypeMetadataによってbuilder生成されるすべてのエンドポイントの に Metadata を追加します。

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

RouteHandlerBuilder。

statusCode

Int32

応答ステータス コード。

responseType

Type

応答の型。 既定値は null です。

contentType

String

応答コンテンツ タイプ。 responseType が null でない場合は、既定値は "application/json" で、それ以外の場合は既定値は null です。

additionalContentTypes

String[]

指定された状態コードに対してエンドポイントによって生成される追加の応答コンテンツ タイプ。

戻り値

RouteHandlerBuilder

RouteHandlerBuilderエンドポイントをさらにカスタマイズするために使用できる 。

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

ソース:

OpenApiRouteHandlerBuilderExtensions.cs

IProducesResponseTypeMetadataによってbuilder生成されるすべてのエンドポイントの に Metadata を追加します。

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

RouteHandlerBuilder。

statusCode

Int32

応答ステータス コード。 既定値は Status200OK です。

contentType

String

応答コンテンツ タイプ。 既定値は "application/json" です。

additionalContentTypes

String[]

指定された状態コードに対してエンドポイントによって生成される追加の応答コンテンツ タイプ。

戻り値

RouteHandlerBuilder

RouteHandlerBuilderエンドポイントをさらにカスタマイズするために使用できる 。