ApiBehaviorOptions.SuppressMapClientErrors Properti

Definisi

Ruang nama:

Microsoft.AspNetCore.Mvc

Rakitan:

Microsoft.AspNetCore.Mvc.Core.dll

Paket:

Microsoft.AspNetCore.App.Ref v8.0.0

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 kumpulan layanan.

public:
 property bool SuppressMapClientErrors { bool get(); void set(bool value); };

public bool SuppressMapClientErrors { get; set; }

member this.SuppressMapClientErrors : bool with get, set

Public Property SuppressMapClientErrors As Boolean

Nilai Properti

Boolean

Nilai defaultnya adalah false.

Keterangan

Properti ini dikaitkan dengan sakelar kompatibilitas dan dapat memberikan perilaku yang berbeda tergantung pada versi kompatibilitas yang dikonfigurasi untuk aplikasi. Lihat CompatibilityVersion untuk panduan dan contoh pengaturan versi kompatibilitas aplikasi.

Mengonfigurasi nilai sakelar kompatibilitas yang diinginkan dengan memanggil setter properti ini akan lebih diutamakan daripada nilai yang disiratkan oleh aplikasi CompatibilityVersion.

Jika versi kompatibilitas aplikasi diatur ke Version_2_1 atau lebih rendah, pengaturan ini akan memiliki nilai false kecuali dikonfigurasi secara eksplisit.

Jika versi kompatibilitas aplikasi diatur ke Version_2_2 atau lebih tinggi, pengaturan ini akan memiliki nilai true kecuali dikonfigurasi secara eksplisit.