語言

OpenApiSchemaTransformerContext.GetOrCreateSchemaAsync 方法

定義

取得或為指定型別創造 。OpenApiSchema 用文件中註冊的 IOpenApiSchemaTransformers 來擴充結構。 如果 parameterDescription 不是空,結構會被擴充以該 ApiParameterDescription 資訊。

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。

適用於