ApiBehaviorOptions 類別

定義

命名空間:

Microsoft.AspNetCore.Mvc

組件:

Microsoft.AspNetCore.Mvc.Core.dll

套件:

Microsoft.AspNetCore.App.Ref v8.0.0

用來設定以 批註之型別 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 。 已設定的值可用來轉換成 IClientErrorActionResultObjectResult 實例，其中 Value 為 ProblemDetails 。 重設 SuppressMapClientErrors 即可停用此功能。
DisableImplicitFromServicesParameters	取得或設定值，判斷參數是否從服務推斷。 只有當 是 false 時 SuppressInferBindingSourcesForParameters ，這個屬性才適用。
InvalidModelStateResponseFactory	在批註 ApiControllerAttribute 的動作上叫用委派，以將無效 ModelStateDictionary 轉換成 IActionResult
SuppressConsumesConstraintForFormFileParameters	取得或設定值，這個值會判斷是否 multipart/form-data 將取用動作條件約束新增至從表單資料系結的參數。
SuppressInferBindingSourcesForParameters	取得或設定值，這個值會判斷是否推斷模型系結來源，以在標注 ApiControllerAttribute 的控制器上動作參數是否被隱藏。 啟用時，會推斷下列來源：顯示為路由值的參數會假設從路徑系結 (Path) 。 型 IFormFile 別和 IFormFileCollection 的參數會假設系結自表單。 如果參數是複雜 (IsComplexType) ，而且會在 DI 容器 (註冊 IServiceCollection ，) 則假設是從服務 Services 系結，除非已明確停用 DisableImplicitFromServicesParameters 此選項。 複雜 (IsComplexType) 的參數會假設系結自本文 (Body) 。 所有其他參數都會假設從查詢系結。
SuppressMapClientErrors	取得或設定值，這個值會判斷是否有轉換特定用戶端錯誤的控制器 ApiControllerAttribute 。 當 時 false ，結果篩選會新增至轉換 的 IClientErrorActionResult API 控制器動作。 否則，會隱藏篩選準則。 根據預設， ClientErrorMapping 會用來對應 IClientErrorActionResult 至 ProblemDetails 傳回為) 值的 ObjectResult 實例 (。 若要自訂篩選 (的輸出，例如，若要傳回不同的錯誤類型) ，請在服務集合中註冊 的 IClientErrorFactory 自訂實作。
SuppressModelStateInvalidFilter	取得或設定值，這個值會決定當 無效時是否傳回 BadRequestObjectResultModelState 的篩選。 .

明確介面實作

IEnumerable.GetEnumerator()	用來設定以 批註之型別 ApiControllerAttribute 行為的選項。
IEnumerable<ICompatibilitySwitch>.GetEnumerator()	用來設定以 批註之型別 ApiControllerAttribute 行為的選項。