ApiBehaviorOptions Kelas

Definisi

Ruang nama:

Microsoft.AspNetCore.Mvc

Rakitan:

Microsoft.AspNetCore.Mvc.Core.dll

Paket:

Microsoft.AspNetCore.App.Ref v8.0.0

Sumber:

ApiBehaviorOptions.cs

Opsi yang digunakan untuk mengonfigurasi perilaku untuk jenis yang dianotasi dengan 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)

Warisan

Object

ApiBehaviorOptions

Penerapan

IEnumerable<ICompatibilitySwitch> IEnumerable

Konstruktor

ApiBehaviorOptions()

Membuat instans baru .ApiBehaviorOptions

Properti

ClientErrorMapping	Mendapatkan peta kode status HTTP ke ClientErrorData. Nilai yang dikonfigurasi digunakan untuk mengubah IClientErrorActionResult ke ObjectResult instans di mana Value adalah ProblemDetails. Penggunaan fitur ini dapat dinonaktifkan dengan mengatur SuppressMapClientErrorsulang .
DisableImplicitFromServicesParameters	Mendapatkan atau menetapkan nilai yang menentukan apakah parameter disimpulkan berasal dari layanan. Properti ini hanya berlaku ketika SuppressInferBindingSourcesForParameters adalah false.
InvalidModelStateResponseFactory	Delegasi yang dipanggil pada tindakan yang dianotasi dengan ApiControllerAttribute untuk mengonversi tidak valid ModelStateDictionary menjadi IActionResult
SuppressConsumesConstraintForFormFileParameters	Mendapatkan atau menetapkan nilai yang menentukan apakah batasan tindakan konsumsi multipart/form-data ditambahkan ke parameter yang terikat dari data formulir.
SuppressInferBindingSourcesForParameters	Mendapatkan atau menetapkan nilai yang menentukan apakah sumber pengikatan model disimpulkan untuk parameter tindakan pada pengontrol yang dianotasi dengan ApiControllerAttribute ditekan. Saat diaktifkan, sumber berikut disimpulkan: Parameter yang muncul sebagai nilai rute, diasumsikan terikat dari jalur (Path). Parameter jenis IFormFile dan IFormFileCollection diasumsikan terikat dari formulir. Parameter yang kompleks (IsComplexType) dan terdaftar dalam Kontainer DI (IServiceCollection) diasumsikan terikat dari layanan Services, kecuali opsi ini secara eksplisit dinonaktifkan DisableImplicitFromServicesParameters. Parameter yang kompleks (IsComplexType) diasumsikan terikat dari isi (Body). Semua parameter lainnya diasumsikan terikat dari kueri.
SuppressMapClientErrors	Mendapatkan atau menetapkan nilai yang menentukan apakah pengontrol dengan ApiControllerAttribute mengubah kesalahan klien tertentu. Ketika false, filter hasil ditambahkan ke tindakan pengontrol API yang mengubah IClientErrorActionResult. Jika tidak, filter ditekan. Secara default, ClientErrorMapping digunakan untuk memetakan IClientErrorActionResult ke ProblemDetails instans (dikembalikan sebagai nilai untuk ObjectResult). Untuk menyesuaikan output filter (misalnya untuk mengembalikan jenis kesalahan yang berbeda), daftarkan implementasi IClientErrorFactory kustom dalam koleksi layanan.
SuppressModelStateInvalidFilter	Mendapatkan atau menetapkan nilai yang menentukan apakah filter yang mengembalikan BadRequestObjectResult ketika ModelState tidak valid ditekan. .

Implementasi Antarmuka Eksplisit

IEnumerable.GetEnumerator()	Opsi yang digunakan untuk mengonfigurasi perilaku untuk jenis yang dianotasi dengan ApiControllerAttribute.
IEnumerable<ICompatibilitySwitch>.GetEnumerator()	Opsi yang digunakan untuk mengonfigurasi perilaku untuk jenis yang dianotasi dengan ApiControllerAttribute.