OpenApiOptions 類別

定義

命名空間:

Microsoft.AspNetCore.OpenApi

組件:

Microsoft.AspNetCore.OpenApi.dll

套件:

Microsoft.AspNetCore.OpenApi v9.0.0-preview.6.24328.4

來源:

OpenApiOptions.cs

支援 OpenAPI 檔建構的選項。

public sealed class OpenApiOptions

type OpenApiOptions = class

Public NotInheritable Class OpenApiOptions

繼承

Object

OpenApiOptions

建構函式

OpenApiOptions()

使用預設 ShouldInclude 述詞，初始化 OpenApiOptions 類別的新實例。

屬性

DocumentName	這個 OpenApiOptions 實例與 OpenAPI 檔的名稱相關聯。
OpenApiVersion	要使用的 OpenAPI 規格版本。 預設為 OpenApi3_0。
ShouldInclude	用來判斷指定 ApiDescription 是否應該包含在指定的 OpenAPI 檔中的委派。

方法

UseOperationTransformer(Func<OpenApiOperation,OpenApiOperationTransformerContext,CancellationToken,Task>)	將指定的委派註冊為目前 OpenApiOptions 實例上的作業轉換程式。
UseSchemaTransformer(Func<OpenApiSchema,OpenApiSchemaTransformerContext,CancellationToken,Task>)	將指定的委派註冊為目前 OpenApiOptions 實例上的架構轉換程式。
UseTransformer(Func<OpenApiDocument,OpenApiDocumentTransformerContext,CancellationToken,Task>)	在目前的 OpenApiOptions 實例上，將指定的委派註冊為文件轉換器。
UseTransformer(IOpenApiDocumentTransformer)	在目前 OpenApiOptions 實例上註冊指定的 IOpenApiDocumentTransformer 實例。
UseTransformer<TTransformerType>()	在目前的 OpenApiOptions 實例上註冊新的文件轉換器。