OpenApiOptions Classe
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Opções para dar suporte à construção de documentos OpenAPI.
public sealed class OpenApiOptionstype OpenApiOptions = classPublic NotInheritable Class OpenApiOptions- Herança
-
OpenApiOptions
Construtores
| OpenApiOptions() |
Inicializa uma nova instância da classe OpenApiOptions com o predicado de ShouldInclude padrão. |
Propriedades
| DocumentName |
O nome do documento OpenAPI ao qual esta instância OpenApiOptions está associada. |
| OpenApiVersion |
A versão da especificação OpenAPI a ser usada. O padrão é OpenApi3_0. |
| ShouldInclude |
Um delegado para determinar se um determinado ApiDescription deve ser incluído no documento OpenAPI especificado. |
Métodos
| UseOperationTransformer(Func<OpenApiOperation,OpenApiOperationTransformerContext,CancellationToken,Task>) |
Registra um determinado delegado como um transformador de operação na instância de OpenApiOptions atual. |
| UseSchemaTransformer(Func<OpenApiSchema,OpenApiSchemaTransformerContext,CancellationToken,Task>) |
Registra um determinado delegado como um transformador de esquema na instância de OpenApiOptions atual. |
| UseTransformer(Func<OpenApiDocument,OpenApiDocumentTransformerContext,CancellationToken,Task>) |
Registra um determinado delegado como um transformador de documento na instância de OpenApiOptions atual. |
| UseTransformer(IOpenApiDocumentTransformer) |
Registra uma determinada instância de IOpenApiDocumentTransformer na instância de OpenApiOptions atual. |
| UseTransformer<TTransformerType>() |
Registra um novo transformador de documento na instância de OpenApiOptions atual. |