OpenApiOptions 類別

定義

命名空間:

Microsoft.AspNetCore.OpenApi

組件:

Microsoft.AspNetCore.OpenApi.dll

套件:

Microsoft.AspNetCore.OpenApi v10.0.0

來源:

OpenApiOptions.cs

支援 OpenAPI 檔建構的選項。

public sealed class OpenApiOptions

type OpenApiOptions = class

Public NotInheritable Class OpenApiOptions

繼承

Object

OpenApiOptions

建構函式

名稱	Description
OpenApiOptions()	初始化一個新的類別實例 OpenApiOptions ，使用預設 ShouldInclude 謂詞。

屬性

名稱	Description
CreateSchemaReferenceId	委託人決定如何為與 OpenAPI 文件中型別相關的結構建立參考 ID。
DocumentName	此實例所關聯的 OpenAPI 文件 OpenApiOptions 名稱。
OpenApiVersion	要使用的 OpenAPI 規格版本。 預設為 OpenApi3_1。
ShouldInclude	一個代表來判斷某個特定 ApiDescription 內容是否應該被納入指定的 OpenAPI 文件中。

方法

名稱	Description
AddDocumentTransformer(Func<OpenApiDocument,OpenApiDocumentTransformerContext,CancellationToken,Task>)	將特定代理註冊為目前 OpenApiOptions 實例的文件轉換器。
AddDocumentTransformer(IOpenApiDocumentTransformer)	在目前OpenApiOptions的實例上註冊給定的 實IOpenApiDocumentTransformer例。
AddDocumentTransformer<TTransformerType>()	在目前 OpenApiOptions 實例上註冊一個新的文件轉換器。
AddOperationTransformer(Func<OpenApiOperation,OpenApiOperationTransformerContext,CancellationToken,Task>)	將特定代理註冊為當前 OpenApiOptions 實例上的操作變換器。
AddOperationTransformer(IOpenApiOperationTransformer)	在目前OpenApiOptions的實例上註冊給定的 實IOpenApiOperationTransformer例。
AddOperationTransformer<TTransformerType>()	在目前 OpenApiOptions 實例上註冊一個新的運算變壓器。
AddSchemaTransformer(Func<OpenApiSchema,OpenApiSchemaTransformerContext,CancellationToken,Task>)	在目前 OpenApiOptions 實例上註冊指定代理為結構轉換器。
AddSchemaTransformer(IOpenApiSchemaTransformer)	在目前OpenApiOptions的實例上註冊給定的 實IOpenApiOperationTransformer例。
AddSchemaTransformer<TTransformerType>()	在目前 OpenApiOptions 實例上註冊一個新的結構轉換器。
CreateDefaultSchemaReferenceId(JsonTypeInfo)	建立給定 JsonTypeInfo結構參考 ID 的預設實作。