OpenApiOptions Classe

Définition

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

public sealed class OpenApiOptions
type OpenApiOptions = class
Public NotInheritable Class OpenApiOptions
Héritage
OpenApiOptions

Constructeurs

Nom Description
OpenApiOptions()

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

Propriétés

Nom Description
CreateSchemaReferenceId

Délégué pour déterminer comment les ID de référence doivent être créés pour les schémas associés aux types dans le document OpenAPI donné.

DocumentName

Nom du document OpenAPI associé à cette OpenApiOptions instance.

OpenApiVersion

Version de la spécification OpenAPI à utiliser. La valeur par défaut est OpenApi3_1.

ShouldInclude

Délégué pour déterminer si un donné ApiDescription doit être inclus dans le document OpenAPI donné.

Méthodes

Nom Description
AddDocumentTransformer(Func<OpenApiDocument,OpenApiDocumentTransformerContext,CancellationToken,Task>)

Inscrit un délégué donné en tant que transformateur de document sur l’instance actuelle OpenApiOptions .

AddDocumentTransformer(Func<OpenApiDocument,OpenApiDocumentTransformerContext,CancellationToken,Task>)

Inscrit un délégué donné en tant que transformateur de document sur l’instance actuelle OpenApiOptions .

AddDocumentTransformer(IOpenApiDocumentTransformer)

Inscrit une instance donnée de IOpenApiDocumentTransformer l’instance actuelle OpenApiOptions .

AddDocumentTransformer<TTransformerType>()

Inscrit un nouveau transformateur de document sur l’instance actuelle OpenApiOptions .

AddOperationTransformer(Func<OpenApiOperation,OpenApiOperationTransformerContext,CancellationToken,Task>)

Inscrit un délégué donné en tant que transformateur d’opération sur l’instance actuelle OpenApiOptions .

AddOperationTransformer(Func<OpenApiOperation,OpenApiOperationTransformerContext,CancellationToken,Task>)

Inscrit un délégué donné en tant que transformateur d’opération sur l’instance actuelle OpenApiOptions .

AddOperationTransformer(IOpenApiOperationTransformer)

Inscrit une instance donnée de IOpenApiOperationTransformer l’instance actuelle OpenApiOptions .

AddOperationTransformer<TTransformerType>()

Inscrit un nouveau transformateur d’opération sur l’instance actuelle OpenApiOptions .

AddSchemaTransformer(Func<OpenApiSchema,OpenApiSchemaTransformerContext,CancellationToken,Task>)

Inscrit un délégué donné en tant que transformateur de schéma sur l’instance actuelle OpenApiOptions .

AddSchemaTransformer(Func<OpenApiSchema,OpenApiSchemaTransformerContext,CancellationToken,Task>)

Inscrit un délégué donné en tant que transformateur de schéma sur l’instance actuelle OpenApiOptions .

AddSchemaTransformer(IOpenApiSchemaTransformer)

Inscrit une instance donnée de IOpenApiOperationTransformer l’instance actuelle OpenApiOptions .

AddSchemaTransformer<TTransformerType>()

Inscrit un nouveau transformateur de schéma sur l’instance actuelle OpenApiOptions .

CreateDefaultSchemaReferenceId(JsonTypeInfo)

Implémentation par défaut pour la création d’un ID de référence de schéma pour un donné JsonTypeInfo.

S’applique à