OpenApiOptions 类

定义

命名空间:

Microsoft.AspNetCore.OpenApi

程序集:

Microsoft.AspNetCore.OpenApi.dll

包:

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

Source:

OpenApiOptions.cs

用于支持 OpenAPI 文档构造的选项。

public sealed class OpenApiOptions

type OpenApiOptions = class

Public NotInheritable Class OpenApiOptions

继承

Object

OpenApiOptions

构造函数

OpenApiOptions()

使用默认 ShouldInclude 谓词初始化 OpenApiOptions 类的新实例。

属性

DocumentName	此 OpenApiOptions 实例与此 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 实例上注册新的文档转换器。