ApiBehaviorOptions クラス

定義

名前空間:

Microsoft.AspNetCore.Mvc

アセンブリ:

Microsoft.AspNetCore.Mvc.Core.dll

パッケージ:

Microsoft.AspNetCore.App.Ref v8.0.0

ソース:

ApiBehaviorOptions.cs

で ApiControllerAttribute注釈が付けられた型の動作を構成するために使用されるオプション。

public class ApiBehaviorOptions : System.Collections.Generic.IEnumerable<Microsoft.AspNetCore.Mvc.Infrastructure.ICompatibilitySwitch>

type ApiBehaviorOptions = class
    interface seq<ICompatibilitySwitch>
    interface IEnumerable

Public Class ApiBehaviorOptions
Implements IEnumerable(Of ICompatibilitySwitch)

継承

Object

ApiBehaviorOptions

実装

IEnumerable<ICompatibilitySwitch> IEnumerable

コンストラクター

ApiBehaviorOptions()

ApiBehaviorOptions の新しいインスタンスを作成します。

プロパティ

ClientErrorMapping	HTTP 状態コードの マップを に ClientErrorData取得します。 構成された値は、 が ValueProblemDetailsのObjectResultインスタンスに変換IClientErrorActionResultするために使用されます。 この機能の使用は、 をリセット SuppressMapClientErrorsすることで無効にすることができます。
DisableImplicitFromServicesParameters	サービスからのパラメーターが推論されるかどうかを決定する値を取得または設定します。 このプロパティは SuppressInferBindingSourcesForParameters が false の場合にのみ適用されます。
InvalidModelStateResponseFactory	無効な ModelStateDictionary を に変換するために、 でApiControllerAttribute注釈が付けられたアクションに対して呼び出されたデリゲートIActionResult
SuppressConsumesConstraintForFormFileParameters	消費アクション制約が、フォーム データからバインドされたパラメーターに追加されるかどうかを multipart/form-data 決定する値を取得または設定します。
SuppressInferBindingSourcesForParameters	注釈が付けられたコントローラーのアクション パラメーターに対してモデル バインド ソースが推論されるかどうかを決定する値を ApiControllerAttribute 取得または設定します。 有効にすると、次のソースが推論されます。ルート値として表示されるパラメーターは、パス (Path) からバインドされていると見なされます。 型 IFormFile と IFormFileCollection のパラメーターは、フォームからバインドされているものと見なされます。 複雑で 、DI コンテナーIServiceCollection (IsComplexType) に登録されているパラメーターは、このオプションが明示的に無効DisableImplicitFromServicesParametersになっていない限り、サービスServicesからバインドされているものと見なされます。 複雑な () パラメーターは、本文 (IsComplexTypeBody) からバインドされているものと見なされます。 他のすべてのパラメーターは、クエリからバインドされているものと見なされます。
SuppressMapClientErrors	コントローラーが特定のクライアント エラーを変換するかどうかを決定する値を ApiControllerAttribute 取得または設定します。 の場合 false、 を変換 IClientErrorActionResultする API コントローラー アクションに結果フィルターが追加されます。 それ以外の場合、フィルターは抑制されます。 既定では、 ClientErrorMapping は インスタンスにProblemDetailsマップIClientErrorActionResultするために使用されます (の値ObjectResultとして返されます)。 フィルターの出力をカスタマイズするには (たとえば、別のエラーの種類を返す場合)、 のカスタム実装 IClientErrorFactory をサービス コレクションに登録します。
SuppressModelStateInvalidFilter	が無効な場合ModelStateに を返すフィルターが抑制されているかどうかを決定する値をBadRequestObjectResult取得または設定します。 .

明示的なインターフェイスの実装

IEnumerable.GetEnumerator()	で ApiControllerAttribute注釈が付けられた型の動作を構成するために使用されるオプション。
IEnumerable<ICompatibilitySwitch>.GetEnumerator()	で ApiControllerAttribute注釈が付けられた型の動作を構成するために使用されるオプション。