ApiBehaviorOptions Класс

Ссылка

Определение

Пространство имен:: Microsoft.AspNetCore.Mvc

Сборка:: Microsoft.AspNetCore.Mvc.Core.dll

Пакет:: Microsoft.AspNetCore.Mvc.Core v2.1.0

Пакет:: Microsoft.AspNetCore.Mvc.Core v2.2.0

Пакет:: Microsoft.AspNetCore.App.Ref v3.0.1

Пакет:: Microsoft.AspNetCore.App.Ref v3.1.10

Пакет:: Microsoft.AspNetCore.App.Ref v5.0.0

Пакет:: Microsoft.AspNetCore.App.Ref v6.0.6

Пакет:: Microsoft.AspNetCore.App.Ref v7.0.5

Пакет:: Microsoft.AspNetCore.App.Ref v8.0.0

Пакет:: Microsoft.AspNetCore.App.Ref v9.0.0-rc.2.24474.3

Исходный код:: ApiBehaviorOptions.cs

Исходный код:: ApiBehaviorOptions.cs

Исходный код:: ApiBehaviorOptions.cs

Важно!

Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.

Параметры, используемые для настройки поведения для типов, помеченных с ApiControllerAttributeпомощью .

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)

Наследование: Object
ApiBehaviorOptions

Реализации: IEnumerable<ICompatibilitySwitch> IEnumerable

Конструкторы

ApiBehaviorOptions()

Создает новый экземпляр ApiBehaviorOptions.

Свойства

AllowInferringBindingSourceForCollectionTypesAsFromQuery	Возвращает или задает значение, определяющее BindingSource , для типов коллекций (IsCollectionType). При `true`значении источник привязки для типов коллекций выводится как Query. В противном случае Body выводится.
ClientErrorMapping	Получает сопоставление кодов состояния HTTP с ClientErrorData. Настроенные значения используются для преобразования IClientErrorActionResult в экземпляр , ObjectResult где Value имеет значение ProblemDetails. Использование этой функции можно отключить, сбросив SuppressMapClientErrors.
DisableImplicitFromServicesParameters	Возвращает или задает значение, определяющее, выводятся ли параметры из служб. Это свойство применимо только в том случае, если SuppressInferBindingSourcesForParameters имеет значение `false`.
InvalidModelStateResponseFactory	Делегат вызывается для действий с заметками , ApiControllerAttribute чтобы преобразовать недопустимый ModelStateDictionary в IActionResult
SuppressConsumesConstraintForFormFileParameters	Возвращает или задает значение, определяющее, добавляется ли `multipart/form-data` ограничение действия к параметрам, связанным с данными формы.
SuppressInferBindingSourcesForParameters	Возвращает или задает значение, определяющее, выводятся ли источники привязки модели для параметров действия на контроллерах, помеченных параметром ApiControllerAttribute , подавляется. Если этот параметр включен, выводятся следующие источники: Предполагается, что параметры, которые отображаются как значения маршрута, привязаны к пути (Path). Предполагается, что параметры типа IFormFile и IFormFileCollection привязаны к форме. Предполагается, что параметры являются сложными (IsComplexType) и зарегистрированы в контейнере внедрения зависимостей (IServiceCollection) от служб Services, если этот параметр явно не отключен DisableImplicitFromServicesParameters. Предполагается, что сложные параметры (IsComplexType) привязаны к тексту (Body). Предполагается, что все остальные параметры привязаны к запросу.
SuppressMapClientErrors	Возвращает или задает значение, определяющее, имеют ли контроллеры с ApiControllerAttribute определенными ошибками клиента. При `false`значении фильтр результатов добавляется к действиям контроллера API, которые преобразуют IClientErrorActionResult. В противном случае фильтр подавляется. По умолчанию ClientErrorMapping используется для сопоставления IClientErrorActionResult с экземпляром ProblemDetails (возвращается в качестве значения для ObjectResult). Чтобы настроить выходные данные фильтра (например, для возврата другого типа ошибки), зарегистрируйте пользовательскую реализацию IClientErrorFactory в коллекции служб.
SuppressModelStateInvalidFilter	Возвращает или задает значение, определяющее, подавляется ли фильтр, возвращающий BadRequestObjectResult , если ModelState является недопустимым. .
SuppressUseValidationProblemDetailsForInvalidModelStateResponses	Возвращает или задает значение, определяющее, если контроллеры, помеченные как ApiControllerAttribute ответ, используются ValidationProblemDetails в InvalidModelStateResponseFactory. При `true`значении SuppressModelStateInvalidFilter возвращает ошибки в как ModelStateDictionary ValidationProblemDetails. В противном случае возвращает ошибки в формате, SuppressModelStateInvalidFilter определенном параметром SerializableError.

Явные реализации интерфейса

IEnumerable.GetEnumerator()	Параметры, используемые для настройки поведения для типов, помеченных с ApiControllerAttributeпомощью .
IEnumerable<ICompatibilitySwitch>.GetEnumerator()	Параметры, используемые для настройки поведения для типов, помеченных с ApiControllerAttributeпомощью .

Применяется к

Поделиться через