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。
備註
回傳的結構會被文件中註冊的任何 IOpenApiSchemaTransformers 所擴充。 若 parameterDescription 非空，結構也會被補充 ApiParameterDescription 資訊，例如預設值與驗證元資料。