OpenApiOptions Sınıf

Tanım

Ad Alanı:

Microsoft.AspNetCore.OpenApi

Bütünleştirilmiş Kod:

Microsoft.AspNetCore.OpenApi.dll

Paket:

Microsoft.AspNetCore.OpenApi v10.0.0

Kaynak:

OpenApiOptions.cs

OpenAPI belgelerinin oluşturulmasını destekleme seçenekleri.

public sealed class OpenApiOptions

type OpenApiOptions = class

Public NotInheritable Class OpenApiOptions

Devralma

Object

OpenApiOptions

Oluşturucular

Name	Description
OpenApiOptions()	Varsayılan ShouldInclude koşulla sınıfının yeni bir örneğini OpenApiOptions başlatır.

Özellikler

Name	Description
CreateSchemaReferenceId	Verilen OpenAPI belgesindeki türlerle ilişkili şemalar için başvuru kimliklerinin nasıl oluşturulması gerektiğini belirleyen bir temsilci.
DocumentName	Bu OpenApiOptions örneğin ilişkili olduğu OpenAPI belgesinin adı.
OpenApiVersion	Kullanılacak OpenAPI belirtiminin sürümü. Varsayılan olarak OpenApi3_1 değerini alır.
ShouldInclude	Verilen openAPI belgesine belirli ApiDescription bir öğe eklenip eklenmeyeceğini belirlemek için bir temsilci.

Yöntemler

Name	Description
AddDocumentTransformer(Func<OpenApiDocument,OpenApiDocumentTransformerContext,CancellationToken,Task>)	Belirli bir temsilciyi geçerli OpenApiOptions örneğe belge dönüştürücü olarak kaydeder.
AddDocumentTransformer(IOpenApiDocumentTransformer)	Geçerli OpenApiOptions örneğe belirli bir örneğini IOpenApiDocumentTransformer kaydeder.
AddDocumentTransformer<TTransformerType>()	Geçerli OpenApiOptions örneğe yeni bir belge transformatörü kaydeder.
AddOperationTransformer(Func<OpenApiOperation,OpenApiOperationTransformerContext,CancellationToken,Task>)	Belirli bir temsilciyi geçerli OpenApiOptions örnekte işlem transformatörü olarak kaydeder.
AddOperationTransformer(IOpenApiOperationTransformer)	Geçerli OpenApiOptions örneğe belirli bir örneğini IOpenApiOperationTransformer kaydeder.
AddOperationTransformer<TTransformerType>()	Geçerli OpenApiOptions örneğe yeni bir işlem transformatörü kaydeder.
AddSchemaTransformer(Func<OpenApiSchema,OpenApiSchemaTransformerContext,CancellationToken,Task>)	Belirli bir temsilciyi geçerli OpenApiOptions örnekte şema transformatörü olarak kaydeder.
AddSchemaTransformer(IOpenApiSchemaTransformer)	Geçerli OpenApiOptions örneğe belirli bir örneğini IOpenApiOperationTransformer kaydeder.
AddSchemaTransformer<TTransformerType>()	Geçerli OpenApiOptions örneğe yeni bir şema transformatörü kaydeder.
CreateDefaultSchemaReferenceId(JsonTypeInfo)	Belirli JsonTypeInfobir için şema başvuru kimliği oluşturmaya yönelik varsayılan uygulama.