OpenApiOptions Clase

Definición

Espacio de nombres:
Microsoft.AspNetCore.OpenApi
Ensamblado:
Microsoft.AspNetCore.OpenApi.dll
Paquete:
Microsoft.AspNetCore.OpenApi v10.0.0
Paquete:
Microsoft.AspNetCore.OpenApi v11.0.0-preview.3.26207.106
Paquete:
Microsoft.AspNetCore.OpenApi v9.0.8
Source:
OpenApiOptions.cs
Source:
OpenApiOptions.cs
Source:
OpenApiOptions.cs

Opciones para admitir la construcción de documentos openAPI.

public sealed class OpenApiOptions
type OpenApiOptions = class
Public NotInheritable Class OpenApiOptions
Herencia
Object
OpenApiOptions

Constructores

Nombre Description
OpenApiOptions()

Inicializa una nueva instancia de la OpenApiOptions clase con el predicado predeterminado ShouldInclude .

Propiedades

Nombre Description
CreateSchemaReferenceId

Delegado para determinar cómo se deben crear los identificadores de referencia para esquemas asociados a tipos en el documento OpenAPI determinado.
DocumentName

Nombre del documento openAPI al que está asociada esta OpenApiOptions instancia.
OpenApiVersion

Versión de la especificación openAPI que se va a usar. Tiene como valor predeterminado OpenApi3_1.
ShouldInclude

Delegado para determinar si un determinado ApiDescription debe incluirse en el documento OpenAPI determinado.

Métodos

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

Registra un delegado determinado como transformador de documento en la instancia actual OpenApiOptions .
AddDocumentTransformer(Func<OpenApiDocument,OpenApiDocumentTransformerContext,CancellationToken,Task>)

Registra un delegado determinado como transformador de documento en la instancia actual OpenApiOptions .
AddDocumentTransformer(IOpenApiDocumentTransformer)

Registra una instancia determinada de IOpenApiDocumentTransformer en la instancia actual OpenApiOptions .
AddDocumentTransformer<TTransformerType>()

Registra un nuevo transformador de documento en la instancia actual OpenApiOptions .
AddOperationTransformer(Func<OpenApiOperation,OpenApiOperationTransformerContext,CancellationToken,Task>)

Registra un delegado determinado como transformador de operación en la instancia actual OpenApiOptions .
AddOperationTransformer(Func<OpenApiOperation,OpenApiOperationTransformerContext,CancellationToken,Task>)

Registra un delegado determinado como transformador de operación en la instancia actual OpenApiOptions .
AddOperationTransformer(IOpenApiOperationTransformer)

Registra una instancia determinada de IOpenApiOperationTransformer en la instancia actual OpenApiOptions .
AddOperationTransformer<TTransformerType>()

Registra un nuevo transformador de operación en la instancia actual OpenApiOptions .
AddSchemaTransformer(Func<OpenApiSchema,OpenApiSchemaTransformerContext,CancellationToken,Task>)

Registra un delegado determinado como transformador de esquema en la instancia actual OpenApiOptions .
AddSchemaTransformer(Func<OpenApiSchema,OpenApiSchemaTransformerContext,CancellationToken,Task>)

Registra un delegado determinado como transformador de esquema en la instancia actual OpenApiOptions .
AddSchemaTransformer(IOpenApiSchemaTransformer)

Registra una instancia determinada de IOpenApiOperationTransformer en la instancia actual OpenApiOptions .
AddSchemaTransformer<TTransformerType>()

Registra un nuevo transformador de esquema en la instancia actual OpenApiOptions .
CreateDefaultSchemaReferenceId(JsonTypeInfo)

Implementación predeterminada para crear un identificador de referencia de esquema para un determinado JsonTypeInfo.

Se aplica a