OpenApiDocumentTransformerContext.GetOrCreateSchemaAsync 메서드
정의
중요
일부 정보는 릴리스되기 전에 상당 부분 수정될 수 있는 시험판 제품과 관련이 있습니다. Microsoft는 여기에 제공된 정보에 대해 어떠한 명시적이거나 묵시적인 보증도 하지 않습니다.
지정된 형식에 대한 값을 OpenApiSchema 가져오거나 만듭니다.
public System.Threading.Tasks.Task<Microsoft.OpenApi.OpenApiSchema> GetOrCreateSchemaAsync(Type type, Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterDescription? parameterDescription = default, System.Threading.CancellationToken cancellationToken = default);
member this.GetOrCreateSchemaAsync : Type * Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterDescription * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.OpenApi.OpenApiSchema>
Public Function GetOrCreateSchemaAsync (type As Type, Optional parameterDescription As ApiParameterDescription = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of OpenApiSchema)
매개 변수
- type
- Type
스키마가 만들어지는 형식입니다.
- parameterDescription
- ApiParameterDescription
스키마를 보강하기 위한 선택적 매개 변수 설명입니다.
- cancellationToken
- CancellationToken
작업을 취소하는 취소 토큰입니다.
반품
형식 OpenApiSchema값이 있는 비동기 작업을 나타내는 작업입니다.
설명
반환된 스키마는 문서에 등록된 모든 IOpenApiSchemaTransformer스키마로 보강됩니다. null이 아닌 경우 parameterDescription 스키마도 기본값 및 유효성 검사 메타데이터와 같은 정보로 ApiParameterDescription 보강됩니다.