OpenApiOptions Clase
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Opciones para admitir la construcción de documentos openAPI.
public sealed class OpenApiOptionstype OpenApiOptions = classPublic NotInheritable Class OpenApiOptions- Herencia
-
OpenApiOptions
Constructores
| OpenApiOptions() |
Inicializa una nueva instancia de la clase OpenApiOptions con el predicado ShouldInclude predeterminado. |
Propiedades
| DocumentName |
Nombre del documento openAPI al que está asociada esta instancia de OpenApiOptions. |
| OpenApiVersion |
Versión de la especificación openAPI que se va a usar. El valor predeterminado es OpenApi3_0. |
| ShouldInclude |
Delegado para determinar si un ApiDescription determinado debe incluirse en el documento OpenAPI determinado. |
Métodos
| UseOperationTransformer(Func<OpenApiOperation,OpenApiOperationTransformerContext,CancellationToken,Task>) |
Registra un delegado determinado como transformador de operación en la instancia de OpenApiOptions actual. |
| UseSchemaTransformer(Func<OpenApiSchema,OpenApiSchemaTransformerContext,CancellationToken,Task>) |
Registra un delegado determinado como transformador de esquema en la instancia de OpenApiOptions actual. |
| UseTransformer(Func<OpenApiDocument,OpenApiDocumentTransformerContext,CancellationToken,Task>) |
Registra un delegado determinado como transformador de documentos en la instancia de OpenApiOptions actual. |
| UseTransformer(IOpenApiDocumentTransformer) |
Registra una instancia determinada de IOpenApiDocumentTransformer en la instancia de OpenApiOptions actual. |
| UseTransformer<TTransformerType>() |
Registra un nuevo transformador de documento en la instancia de OpenApiOptions actual. |