OpenApiOptions Класс

Ссылка

Определение

Пространство имен:: Microsoft.AspNetCore.OpenApi

Сборка:: Microsoft.AspNetCore.OpenApi.dll

Пакет:: Microsoft.AspNetCore.OpenApi v9.0.0-preview.6.24328.4

Исходный код:: OpenApiOptions.cs

Важно!

Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.

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

public sealed class OpenApiOptions

type OpenApiOptions = class

Public NotInheritable Class OpenApiOptions

Наследование: Object
OpenApiOptions

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

OpenApiOptions()

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

Свойства

DocumentName	Имя документа OpenAPI, с которым связан этот экземпляр OpenApiOptions.
OpenApiVersion	Используемая версия спецификации OpenAPI. По умолчанию используется OpenApi3_0.
ShouldInclude	Делегат, определяющий, следует ли включить заданный ApiDescription в данный документ OpenAPI.

Методы

UseOperationTransformer(Func<OpenApiOperation,OpenApiOperationTransformerContext,CancellationToken,Task>)	Регистрирует данный делегат в качестве преобразователя операций в текущем экземпляре OpenApiOptions.
UseSchemaTransformer(Func<OpenApiSchema,OpenApiSchemaTransformerContext,CancellationToken,Task>)	Регистрирует данный делегат в качестве преобразователя схемы в текущем экземпляре OpenApiOptions.
UseTransformer(Func<OpenApiDocument,OpenApiDocumentTransformerContext,CancellationToken,Task>)	Регистрирует данный делегат в качестве преобразователя документов в текущем экземпляре OpenApiOptions.
UseTransformer(IOpenApiDocumentTransformer)	Регистрирует данный экземпляр IOpenApiDocumentTransformer в текущем экземпляре OpenApiOptions.
UseTransformer<TTransformerType>()	Регистрирует новый преобразователь документов в текущем экземпляре OpenApiOptions.

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

Поделиться через