OpenApiOptions クラス

定義

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

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

public sealed class OpenApiOptions

type OpenApiOptions = class

Public NotInheritable Class 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 インスタンスに新しいドキュメントトランスフォーマーを登録します。