ApiBehaviorOptions Sınıf

Başvuru

Tanım

Ad Alanı:: Microsoft.AspNetCore.Mvc

Bütünleştirilmiş Kod:: Microsoft.AspNetCore.Mvc.Core.dll

Paket:: Microsoft.AspNetCore.Mvc.Core v2.1.0

Paket:: Microsoft.AspNetCore.Mvc.Core v2.2.0

Paket:: Microsoft.AspNetCore.App.Ref v3.0.1

Paket:: Microsoft.AspNetCore.App.Ref v3.1.10

Paket:: Microsoft.AspNetCore.App.Ref v5.0.0

Paket:: Microsoft.AspNetCore.App.Ref v6.0.6

Paket:: Microsoft.AspNetCore.App.Ref v7.0.5

Paket:: Microsoft.AspNetCore.App.Ref v8.0.0

Paket:: Microsoft.AspNetCore.App.Ref v9.0.0-rc.2.24474.3

Kaynak:: ApiBehaviorOptions.cs

Kaynak:: ApiBehaviorOptions.cs

Kaynak:: ApiBehaviorOptions.cs

Önemli

Bazı bilgiler ürünün ön sürümüyle ilgilidir ve sürüm öncesinde önemli değişiklikler yapılmış olabilir. Burada verilen bilgilerle ilgili olarak Microsoft açık veya zımni hiçbir garanti vermez.

ile ApiControllerAttributeek açıklama eklenen türlerde davranışı yapılandırmak için kullanılan seçenekler.

public ref class ApiBehaviorOptions

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

public class ApiBehaviorOptions

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

type ApiBehaviorOptions = class

type ApiBehaviorOptions = class
    interface seq<ICompatibilitySwitch>
    interface IEnumerable

Public Class ApiBehaviorOptions

Public Class ApiBehaviorOptions
Implements IEnumerable(Of ICompatibilitySwitch)

Devralma: Object
ApiBehaviorOptions

Uygulamalar: IEnumerable<ICompatibilitySwitch> IEnumerable

Oluşturucular

ApiBehaviorOptions()

ApiBehaviorOptions öğesinin yeni bir örneğini oluşturur.

Özellikler

AllowInferringBindingSourceForCollectionTypesAsFromQuery	Koleksiyon türleriIsCollectionType () için olup olmadığını BindingSource belirleyen bir değer alır veya ayarlar. olduğunda `true`, koleksiyon türleri için bağlama kaynağı olarak Queryçıkarsanır. Aksi takdirde Body çıkarılır.
ClientErrorMapping	HTTP durum kodlarının ile eşlemini ClientErrorDataalır. Yapılandırılan değerler, olduğu Value ProblemDetailsbir ObjectResult örneğe dönüştürmek IClientErrorActionResult için kullanılır. Bu özelliğin kullanımı sıfırlanarak SuppressMapClientErrorsdevre dışı bırakılabilir.
DisableImplicitFromServicesParameters	Parametrelerin hizmetlerden çıkarılıp çıkarılmadığını belirleyen bir değer alır veya ayarlar. Bu özellik yalnızca olduğunda SuppressInferBindingSourcesForParameters`false`geçerlidir.
InvalidModelStateResponseFactory	Geçersiz ModelStateDictionary bir öğeyi bire dönüştürmek için ek açıklama ekli ApiControllerAttribute eylemlerde çağrılan temsilciIActionResult
SuppressConsumesConstraintForFormFileParameters	Form verilerinden bağlanan parametrelere bir tüketen eylem kısıtlaması eklenip eklenmediğini belirleyen bir `multipart/form-data` değer alır veya ayarlar.
SuppressInferBindingSourcesForParameters	Model bağlama kaynaklarının açıklama eklenmiş denetleyicilerdeki eylem parametreleri için çıkarılıp çıkarılmadığını belirleyen bir ApiControllerAttribute değeri alır veya ayarlar. Etkinleştirildiğinde, aşağıdaki kaynaklar çıkarılır: Yol değerleri olarak görünen parametrelerin yoldan (Path ) bağlı olduğu varsayılır. ve IFormFileCollection türündeki IFormFile parametrelerin formdan bağlanacağı varsayılır. Karmaşık (IsComplexType) olan ve DI Kapsayıcısına (IServiceCollection) kaydedilen parametrelerin, bu seçenek açıkça devre dışı bırakılmadığı DisableImplicitFromServicesParameterssürece hizmetlerden Servicesbağlı olduğu varsayılır. Karmaşık () parametrelerin gövdeden (IsComplexType Body) bağlanacağı varsayılır. Diğer tüm parametrelerin sorgudan bağlı olduğu varsayılır.
SuppressMapClientErrors	Belirli istemci hatalarını dönüştüren denetleyicilerin ApiControllerAttribute olup olmadığını belirleyen bir değer alır veya ayarlar. olduğunda `false`, dönüştüren IClientErrorActionResultAPI denetleyicisi eylemlerine bir sonuç filtresi eklenir. Aksi takdirde filtre gizlenmiş olur. Varsayılan olarak, ClientErrorMapping bir ProblemDetails örneğe eşlemek IClientErrorActionResult için kullanılır (değeri ObjectResultolarak döndürülür). Filtrenin çıkışını özelleştirmek için (örneğin farklı bir hata türü döndürmek için), özel uygulamasını IClientErrorFactory hizmet koleksiyonuna kaydedin.
SuppressModelStateInvalidFilter	Geçersiz olduğunda ModelState döndüren filtrenin gizlenip gizlenmediğini belirleyen bir BadRequestObjectResult değer alır veya ayarlar. .
SuppressUseValidationProblemDetailsForInvalidModelStateResponses	denetleyicilerinin içinde InvalidModelStateResponseFactorykullanarak ValidationProblemDetails yanıtla ApiControllerAttribute ek açıklama eklenip eklenmediğini belirleyen bir değer alır veya ayarlar. olduğunda `true`, SuppressModelStateInvalidFilter içindeki ModelStateDictionary hataları olarak ValidationProblemDetailsdöndürür. Aksi takdirde, SuppressModelStateInvalidFilter tarafından SerializableErrorbelirlenen biçimdeki hataları döndürür.

Belirtik Arabirim Kullanımları

IEnumerable.GetEnumerator()	ile ApiControllerAttributeek açıklama eklenen türlerde davranışı yapılandırmak için kullanılan seçenekler.
IEnumerable<ICompatibilitySwitch>.GetEnumerator()	ile ApiControllerAttributeek açıklama eklenen türlerde davranışı yapılandırmak için kullanılan seçenekler.

Şunlara uygulanır

Aracılığıyla paylaş