Language

OpenApiOptions クラス

定義

名前空間:
Microsoft.AspNetCore.OpenApi
アセンブリ:
Microsoft.AspNetCore.OpenApi.dll
パッケージ:
Microsoft.AspNetCore.OpenApi v10.0.0
パッケージ:
Microsoft.AspNetCore.OpenApi v11.0.0-rc.2.26504.105
パッケージ:
Microsoft.AspNetCore.OpenApi v9.0.8
ソース:
OpenApiOptions.cs
ソース:
OpenApiOptions.cs
ソース:
OpenApiOptions.cs

OpenAPI ドキュメントの構築をサポートするためのオプション。

public sealed class OpenApiOptions
type OpenApiOptions = class
Public NotInheritable Class OpenApiOptions
継承
Object
OpenApiOptions

コンストラクター

Name 説明
OpenApiOptions()

既定のOpenApiOptions述語を使用して、ShouldInclude クラスの新しいインスタンスを初期化します。

プロパティ

Name 説明
CreateSchemaReferenceId

指定された OpenAPI ドキュメント内の型に関連付けられているスキーマの参照 ID を作成する方法を決定するデリゲート。
DocumentName

この OpenApiOptions インスタンスが関連付けられている OpenAPI ドキュメントの名前。
OpenApiVersion

使用する OpenAPI 仕様のバージョン。 既定値は OpenApi3_2 です。
ShouldInclude

特定の ApiDescription を特定の OpenAPI ドキュメントに含める必要があるかどうかを判断するデリゲート。

メソッド

Name 説明
AddDocumentTransformer(Func<OpenApiDocument,OpenApiDocumentTransformerContext,CancellationToken,Task>)

現在の OpenApiOptions インスタンスで、指定されたデリゲートをドキュメント トランスフォーマーとして登録します。
AddDocumentTransformer(Func<OpenApiDocument,OpenApiDocumentTransformerContext,CancellationToken,Task>)

現在の OpenApiOptions インスタンスで、指定されたデリゲートをドキュメント トランスフォーマーとして登録します。
AddDocumentTransformer(IOpenApiDocumentTransformer)

現在のIOpenApiDocumentTransformer インスタンスにOpenApiOptionsの特定のインスタンスを登録します。
AddDocumentTransformer<TTransformerType>()

現在の OpenApiOptions インスタンスに新しいドキュメント トランスフォーマーを登録します。
AddOperationTransformer(Func<OpenApiOperation,OpenApiOperationTransformerContext,CancellationToken,Task>)

現在の OpenApiOptions インスタンスで、特定のデリゲートを操作トランスフォーマーとして登録します。
AddOperationTransformer(Func<OpenApiOperation,OpenApiOperationTransformerContext,CancellationToken,Task>)

現在の OpenApiOptions インスタンスで、特定のデリゲートを操作トランスフォーマーとして登録します。
AddOperationTransformer(IOpenApiOperationTransformer)

現在のIOpenApiOperationTransformer インスタンスにOpenApiOptionsの特定のインスタンスを登録します。
AddOperationTransformer<TTransformerType>()

現在の OpenApiOptions インスタンスに新しい操作トランスフォーマーを登録します。
AddSchemaTransformer(Func<OpenApiSchema,OpenApiSchemaTransformerContext,CancellationToken,Task>)

現在の OpenApiOptions インスタンスで、特定のデリゲートをスキーマ トランスフォーマーとして登録します。
AddSchemaTransformer(Func<OpenApiSchema,OpenApiSchemaTransformerContext,CancellationToken,Task>)

現在の OpenApiOptions インスタンスで、特定のデリゲートをスキーマ トランスフォーマーとして登録します。
AddSchemaTransformer(IOpenApiSchemaTransformer)

現在のIOpenApiOperationTransformer インスタンスにOpenApiOptionsの特定のインスタンスを登録します。
AddSchemaTransformer<TTransformerType>()

現在の OpenApiOptions インスタンスに新しいスキーマ トランスフォーマーを登録します。
CreateDefaultSchemaReferenceId(JsonTypeInfo)

特定の JsonTypeInfoのスキーマ参照 ID を作成するための既定の実装。

適用対象