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


ApiBehaviorOptions Класс

Определение

Параметры, используемые для настройки поведения для типов, помеченных с 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)
Наследование
ApiBehaviorOptions
Реализации

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

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 возвращает ошибки в как ModelStateDictionaryValidationProblemDetails. В противном случае возвращает ошибки в формате, SuppressModelStateInvalidFilter определенном параметром SerializableError.

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

IEnumerable.GetEnumerator()

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

IEnumerable<ICompatibilitySwitch>.GetEnumerator()

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

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