OpenApiOptions Classe

Definizione

Spazio dei nomi:
Microsoft.AspNetCore.OpenApi
Assembly:
Microsoft.AspNetCore.OpenApi.dll
Pacchetto:
Microsoft.AspNetCore.OpenApi v10.0.0
Pacchetto:
Microsoft.AspNetCore.OpenApi v11.0.0-preview.3.26207.106
Pacchetto:
Microsoft.AspNetCore.OpenApi v9.0.8
Origine:
OpenApiOptions.cs
Origine:
OpenApiOptions.cs
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

Nome Descrizione
OpenApiOptions()

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

Proprietà

Nome Descrizione
CreateSchemaReferenceId

Delegato per determinare la modalità di creazione degli ID di riferimento per gli schemi associati ai tipi nel documento OpenAPI specificato.
DocumentName

Il nome del documento OpenAPI a cui è associata questa OpenApiOptions istanza.
OpenApiVersion

Versione della specifica OpenAPI da usare. Il valore predefinito è OpenApi3_1.
ShouldInclude

Delegato per determinare se un dato ApiDescription elemento deve essere incluso nel documento OpenAPI specificato.

Metodi

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

Registra un delegato specificato come trasformatore di documento nell'istanza corrente OpenApiOptions .
AddDocumentTransformer(Func<OpenApiDocument,OpenApiDocumentTransformerContext,CancellationToken,Task>)

Registra un delegato specificato come trasformatore di documento nell'istanza corrente OpenApiOptions .
AddDocumentTransformer(IOpenApiDocumentTransformer)

Registra una determinata istanza di IOpenApiDocumentTransformer nell'istanza corrente OpenApiOptions .
AddDocumentTransformer<TTransformerType>()

Registra un nuovo trasformatore di documento nell'istanza corrente OpenApiOptions .
AddOperationTransformer(Func<OpenApiOperation,OpenApiOperationTransformerContext,CancellationToken,Task>)

Registra un delegato specificato come trasformatore di operazione nell'istanza corrente OpenApiOptions .
AddOperationTransformer(Func<OpenApiOperation,OpenApiOperationTransformerContext,CancellationToken,Task>)

Registra un delegato specificato come trasformatore di operazione nell'istanza corrente OpenApiOptions .
AddOperationTransformer(IOpenApiOperationTransformer)

Registra una determinata istanza di IOpenApiOperationTransformer nell'istanza corrente OpenApiOptions .
AddOperationTransformer<TTransformerType>()

Registra un nuovo trasformatore di operazione nell'istanza corrente OpenApiOptions .
AddSchemaTransformer(Func<OpenApiSchema,OpenApiSchemaTransformerContext,CancellationToken,Task>)

Registra un delegato specificato come trasformatore di schema nell'istanza corrente OpenApiOptions .
AddSchemaTransformer(Func<OpenApiSchema,OpenApiSchemaTransformerContext,CancellationToken,Task>)

Registra un delegato specificato come trasformatore di schema nell'istanza corrente OpenApiOptions .
AddSchemaTransformer(IOpenApiSchemaTransformer)

Registra una determinata istanza di IOpenApiOperationTransformer nell'istanza corrente OpenApiOptions .
AddSchemaTransformer<TTransformerType>()

Registra un nuovo trasformatore di schema nell'istanza corrente OpenApiOptions .
CreateDefaultSchemaReferenceId(JsonTypeInfo)

Implementazione predefinita per la creazione di un ID riferimento dello schema per un determinato JsonTypeInfooggetto .

Si applica a