OpenApiOptions Класс

Определение

Пространство имен:
Microsoft.AspNetCore.OpenApi
Сборка:
Microsoft.AspNetCore.OpenApi.dll
Пакет:
Microsoft.AspNetCore.OpenApi v10.0.0
Пакет:
Microsoft.AspNetCore.OpenApi v11.0.0-preview.3.26207.106
Пакет:
Microsoft.AspNetCore.OpenApi v9.0.8
Исходный код:
OpenApiOptions.cs
Исходный код:
OpenApiOptions.cs
Исходный код:
OpenApiOptions.cs

Параметры для поддержки создания документов OpenAPI.

public sealed class OpenApiOptions
type OpenApiOptions = class
Public NotInheritable Class OpenApiOptions
Наследование
Object
OpenApiOptions

Конструкторы

Имя Описание
OpenApiOptions()

Инициализирует новый экземпляр OpenApiOptions класса с предикатом по умолчанию ShouldInclude .

Свойства

Имя Описание
CreateSchemaReferenceId

Делегат для определения способа создания ссылочных идентификаторов для схем, связанных с типами в данном документе OpenAPI.
DocumentName

Имя документа OpenAPI, с которым связан этот OpenApiOptions экземпляр.
OpenApiVersion

Используемая версия спецификации OpenAPI. По умолчанию — OpenApi3_1.
ShouldInclude

Делегат, определяющий, следует ли включать данное значение ApiDescription в указанный документ OpenAPI.

Методы

Имя Описание
AddDocumentTransformer(Func<OpenApiDocument,OpenApiDocumentTransformerContext,CancellationToken,Task>)

Регистрирует заданный делегат в качестве преобразователя документов в текущем OpenApiOptions экземпляре.
AddDocumentTransformer(Func<OpenApiDocument,OpenApiDocumentTransformerContext,CancellationToken,Task>)

Регистрирует заданный делегат в качестве преобразователя документов в текущем OpenApiOptions экземпляре.
AddDocumentTransformer(IOpenApiDocumentTransformer)

Регистрирует данный экземпляр IOpenApiDocumentTransformer в текущем OpenApiOptions экземпляре.
AddDocumentTransformer<TTransformerType>()

Регистрирует новый преобразователь документов в текущем OpenApiOptions экземпляре.
AddOperationTransformer(Func<OpenApiOperation,OpenApiOperationTransformerContext,CancellationToken,Task>)

Регистрирует заданный делегат в качестве преобразователя операций в текущем OpenApiOptions экземпляре.
AddOperationTransformer(Func<OpenApiOperation,OpenApiOperationTransformerContext,CancellationToken,Task>)

Регистрирует заданный делегат в качестве преобразователя операций в текущем OpenApiOptions экземпляре.
AddOperationTransformer(IOpenApiOperationTransformer)

Регистрирует данный экземпляр IOpenApiOperationTransformer в текущем OpenApiOptions экземпляре.
AddOperationTransformer<TTransformerType>()

Регистрирует новый преобразователь операций в текущем OpenApiOptions экземпляре.
AddSchemaTransformer(Func<OpenApiSchema,OpenApiSchemaTransformerContext,CancellationToken,Task>)

Регистрирует данный делегат в качестве преобразователя схемы в текущем OpenApiOptions экземпляре.
AddSchemaTransformer(Func<OpenApiSchema,OpenApiSchemaTransformerContext,CancellationToken,Task>)

Регистрирует данный делегат в качестве преобразователя схемы в текущем OpenApiOptions экземпляре.
AddSchemaTransformer(IOpenApiSchemaTransformer)

Регистрирует данный экземпляр IOpenApiOperationTransformer в текущем OpenApiOptions экземпляре.
AddSchemaTransformer<TTransformerType>()

Регистрирует новый преобразователь схемы в текущем OpenApiOptions экземпляре.
CreateDefaultSchemaReferenceId(JsonTypeInfo)

Реализация по умолчанию для создания идентификатора ссылки на схему для заданного.JsonTypeInfo

Применяется к