다음을 통해 공유


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

컬렉션 형식(IsCollectionType)에 대한 여부를 BindingSource 결정하는 값을 가져오거나 설정합니다.

이면 true컬렉션 형식에 대한 바인딩 소스가 로 Query유추됩니다. 그렇지 않으면 Body 유추됩니다.

ClientErrorMapping

에 대한 HTTP 상태 코드의 맵을 ClientErrorData가져옵니다. 구성된 값은 가 인 ObjectResult instance ValueProblemDetails변환 IClientErrorActionResult 하는 데 사용됩니다.

이 기능을 다시 설정 SuppressMapClientErrors하여 사용하지 않도록 설정할 수 있습니다.

DisableImplicitFromServicesParameters

매개 변수가 서비스에서 유추되는지 여부를 결정하는 값을 가져오거나 설정합니다. 이 속성은 가 인 경우에만 적용됩니다 SuppressInferBindingSourcesForParametersfalse.

InvalidModelStateResponseFactory

잘못된 ModelStateDictionary 를 로 변환하기 위해 주석이 추가된 작업에 대해 호출된 ApiControllerAttribute 대리자IActionResult

SuppressConsumesConstraintForFormFileParameters

사용 중인 작업 제약 조건이 양식 데이터에서 바인딩된 매개 변수에 추가되는지 여부를 multipart/form-data 결정하는 값을 가져오거나 설정합니다.

SuppressInferBindingSourcesForParameters

로 주석이 추가 ApiControllerAttribute 된 컨트롤러의 작업 매개 변수에 대해 모델 바인딩 원본이 유추되는지 여부를 결정하는 값을 가져오거나 설정합니다.

사용하도록 설정하면 다음 원본이 유추됩니다. 경로 값으로 표시되는 매개 변수는 경로(Path)에서 바인딩된 것으로 간주됩니다. 형식 IFormFileIFormFileCollection 형식의 매개 변수는 양식에서 바인딩된 것으로 간주됩니다. 이 옵션을 명시적으로 DisableImplicitFromServicesParameters사용하지 않도록 설정하지 않는 한 복잡하고IsComplexType DI 컨테이너(IServiceCollection)에 등록된 매개 변수는 서비스에서 Services바인딩된 것으로 간주됩니다. 복합(IsComplexType)인 매개 변수는 본문(Body)에서 바인딩된 것으로 간주됩니다. 다른 모든 매개 변수는 쿼리에서 바인딩된 것으로 간주됩니다.

SuppressMapClientErrors

특정 클라이언트 오류를 변환하는 컨트롤러 ApiControllerAttribute 가 있는지 여부를 결정하는 값을 가져오거나 설정합니다.

이면 false결과 필터가 를 변환하는 API 컨트롤러 작업에 추가됩니다 IClientErrorActionResult. 그렇지 않으면 필터가 표시되지 않습니다.

기본적으로 는 ClientErrorMapping 에 대한 값으로 반환되는 ProblemDetails instance 매핑 IClientErrorActionResult 하는 ObjectResult데 사용됩니다.

필터의 출력을 사용자 지정하려면(예: 다른 오류 형식을 반환하기 위해) 서비스 컬렉션에 의 IClientErrorFactory 사용자 지정 구현을 등록합니다.

SuppressModelStateInvalidFilter

가 유효하지 않을 때 ModelState 를 반환 BadRequestObjectResult 하는 필터가 표시되지 않는지 여부를 결정하는 값을 가져오거나 설정합니다. .

SuppressUseValidationProblemDetailsForInvalidModelStateResponses

에서 을 사용하여 ValidationProblemDetailsInvalidModelStateResponseFactory응답으로 주석이 추가된 ApiControllerAttribute 컨트롤러를 결정하는 값을 가져오거나 설정합니다.

이면 trueSuppressModelStateInvalidFilter 에서 ModelStateDictionary 오류를 로 ValidationProblemDetails반환합니다. 그렇지 않으면 에서 SuppressModelStateInvalidFilter 결정한 SerializableError형식으로 오류를 반환합니다.

명시적 인터페이스 구현

IEnumerable.GetEnumerator()

로 주석이 추가된 형식의 동작을 구성하는 데 사용되는 옵션입니다 ApiControllerAttribute.

IEnumerable<ICompatibilitySwitch>.GetEnumerator()

로 주석이 추가된 형식의 동작을 구성하는 데 사용되는 옵션입니다 ApiControllerAttribute.

적용 대상