ApiBehaviorOptions.SuppressMapClientErrors Свойство

Определение

Пространство имен:

Microsoft.AspNetCore.Mvc

Сборка:

Microsoft.AspNetCore.Mvc.Core.dll

Пакет:

Microsoft.AspNetCore.App.Ref v8.0.0

Возвращает или задает значение, определяющее, имеют ли контроллеры с ApiControllerAttribute определенными ошибками клиента.

При falseзначении фильтр результатов добавляется к действиям контроллера API, которые преобразуют IClientErrorActionResult. В противном случае фильтр подавляется.

По умолчанию ClientErrorMapping используется для сопоставления IClientErrorActionResult с экземпляром ProblemDetails (возвращается в качестве значения для ObjectResult).

Чтобы настроить выходные данные фильтра (например, для возврата другого типа ошибки), зарегистрируйте пользовательскую реализацию IClientErrorFactory в коллекции служб.

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

Значение свойства

Boolean

Значение по умолчанию — false.

Комментарии

Это свойство связано с параметром совместимости и может обеспечить другое поведение в зависимости от версии совместимости, настроенной для приложения. Инструкции и примеры настройки версии совместимости приложения см CompatibilityVersion . в этой статье.

Настройка требуемого значения параметра совместимости путем вызова метода задания этого свойства будет иметь приоритет над значением, подразумеваемым в приложении CompatibilityVersion.

Если версия совместимости приложения имеет значение Version_2_1 или ниже, этот параметр будет иметь значение false , если не настроено явным образом.

Если для версии совместимости приложения задано значение Version_2_2 или выше, этот параметр будет иметь значение true , если не настроено явным образом.