OpenApiOptions Classe

Définition

Espace de noms:

Microsoft.AspNetCore.OpenApi

Assembly:

Microsoft.AspNetCore.OpenApi.dll

Paquet:

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

Source:

OpenApiOptions.cs

Options de prise en charge de la construction de documents OpenAPI.

public sealed class OpenApiOptions

type OpenApiOptions = class

Public NotInheritable Class OpenApiOptions

Héritage

Object

OpenApiOptions

Constructeurs

OpenApiOptions()

Initialise une nouvelle instance de la classe OpenApiOptions avec le prédicat ShouldInclude par défaut.

Propriétés

DocumentName	Nom du document OpenAPI associé à cette instance OpenApiOptions.
OpenApiVersion	Version de la spécification OpenAPI à utiliser. La valeur par défaut est OpenApi3_0.
ShouldInclude	Délégué pour déterminer si une ApiDescription donnée doit être incluse dans le document OpenAPI donné.

Méthodes

UseOperationTransformer(Func<OpenApiOperation,OpenApiOperationTransformerContext,CancellationToken,Task>)	Inscrit un délégué donné en tant que transformateur d’opération sur l’instance de OpenApiOptions actuelle.
UseSchemaTransformer(Func<OpenApiSchema,OpenApiSchemaTransformerContext,CancellationToken,Task>)	Inscrit un délégué donné en tant que transformateur de schéma sur l’instance de OpenApiOptions actuelle.
UseTransformer(Func<OpenApiDocument,OpenApiDocumentTransformerContext,CancellationToken,Task>)	Inscrit un délégué donné en tant que transformateur de document sur l’instance de OpenApiOptions actuelle.
UseTransformer(IOpenApiDocumentTransformer)	Inscrit une instance donnée de IOpenApiDocumentTransformer sur l’instance de OpenApiOptions actuelle.
UseTransformer<TTransformerType>()	Inscrit un nouveau transformateur de document sur l’instance de OpenApiOptions actuelle.