OpenApiOptions Classe

Definizione

Spazio dei nomi:

Microsoft.AspNetCore.OpenApi

Assembly:

Microsoft.AspNetCore.OpenApi.dll

Pacchetto:

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

Origine:

OpenApiOptions.cs

Opzioni per supportare la costruzione di documenti OpenAPI.

public sealed class OpenApiOptions

type OpenApiOptions = class

Public NotInheritable Class OpenApiOptions

Ereditarietà

Object

OpenApiOptions

Costruttori

OpenApiOptions()

Inizializza una nuova istanza della classe OpenApiOptions con il predicato ShouldInclude predefinito.

Proprietà

DocumentName	Il nome del documento OpenAPI a cui è associata questa istanza OpenApiOptions.
OpenApiVersion	Versione della specifica OpenAPI da usare. Il valore predefinito è OpenApi3_0.
ShouldInclude	Delegato per determinare se un determinato ApiDescription deve essere incluso nel documento OpenAPI specificato.

Metodi

UseOperationTransformer(Func<OpenApiOperation,OpenApiOperationTransformerContext,CancellationToken,Task>)	Registra un delegato specificato come trasformatore di operazione nell'istanza di OpenApiOptions corrente.
UseSchemaTransformer(Func<OpenApiSchema,OpenApiSchemaTransformerContext,CancellationToken,Task>)	Registra un delegato specificato come trasformatore di schema nell'istanza di OpenApiOptions corrente.
UseTransformer(Func<OpenApiDocument,OpenApiDocumentTransformerContext,CancellationToken,Task>)	Registra un delegato specificato come trasformatore di documento nell'istanza di OpenApiOptions corrente.
UseTransformer(IOpenApiDocumentTransformer)	Registra una determinata istanza di IOpenApiDocumentTransformer nell'istanza di OpenApiOptions corrente.
UseTransformer<TTransformerType>()	Registra un nuovo trasformatore di documento nell'istanza di OpenApiOptions corrente.