OpenApiOptions Classe

Definição

Namespace:

Microsoft.AspNetCore.OpenApi

Assembly:

Microsoft.AspNetCore.OpenApi.dll

Pacote:

Microsoft.AspNetCore.OpenApi v9.0.2

Origem:

OpenApiOptions.cs

Opções para dar suporte à construção de documentos OpenAPI.

public sealed class OpenApiOptions

type OpenApiOptions = class

Public NotInheritable Class OpenApiOptions

Herança

Object

OpenApiOptions

Construtores

OpenApiOptions()

Inicializa uma nova instância da classe OpenApiOptions com o predicado de ShouldInclude padrão.

Propriedades

CreateSchemaReferenceId	Um delegado para determinar como as IDs de referência devem ser criadas para esquemas associados a tipos no documento OpenAPI especificado.
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

AddDocumentTransformer(Func<OpenApiDocument,OpenApiDocumentTransformerContext,CancellationToken,Task>)	Registra um determinado delegado como um transformador de documento na instância de OpenApiOptions atual.
AddDocumentTransformer(IOpenApiDocumentTransformer)	Registra uma determinada instância de IOpenApiDocumentTransformer na instância de OpenApiOptions atual.
AddDocumentTransformer<TTransformerType>()	Registra um novo transformador de documento na instância de OpenApiOptions atual.
AddOperationTransformer(Func<OpenApiOperation,OpenApiOperationTransformerContext,CancellationToken,Task>)	Registra um determinado delegado como um transformador de operação na instância de OpenApiOptions atual.
AddOperationTransformer(IOpenApiOperationTransformer)	Registra uma determinada instância de IOpenApiOperationTransformer na instância de OpenApiOptions atual.
AddOperationTransformer<TTransformerType>()	Registra um novo transformador de operação na instância de OpenApiOptions atual.
AddSchemaTransformer(Func<OpenApiSchema,OpenApiSchemaTransformerContext,CancellationToken,Task>)	Registra um determinado delegado como um transformador de esquema na instância de OpenApiOptions atual.
AddSchemaTransformer(IOpenApiSchemaTransformer)	Registra uma determinada instância de IOpenApiOperationTransformer na instância de OpenApiOptions atual.
AddSchemaTransformer<TTransformerType>()	Registra um novo transformador de esquema na instância de OpenApiOptions atual.
CreateDefaultSchemaReferenceId(JsonTypeInfo)	Uma implementação padrão para criar uma ID de referência de esquema para um determinado JsonTypeInfo.