OpenApiOptions Kelas

Definisi

Ruang nama:

Microsoft.AspNetCore.OpenApi

Rakitan:

Microsoft.AspNetCore.OpenApi.dll

Paket:

Microsoft.AspNetCore.OpenApi v10.0.0

Sumber:

OpenApiOptions.cs

Opsi untuk mendukung pembangunan dokumen OpenAPI.

public sealed class OpenApiOptions

type OpenApiOptions = class

Public NotInheritable Class OpenApiOptions

Warisan

Object

OpenApiOptions

Konstruktor

Nama	Deskripsi
OpenApiOptions()	Menginisialisasi instans OpenApiOptions baru kelas dengan predikat default ShouldInclude .

Properti

Nama	Deskripsi
CreateSchemaReferenceId	Delegasi untuk menentukan bagaimana ID referensi harus dibuat untuk skema yang terkait dengan jenis dalam dokumen OpenAPI yang diberikan.
DocumentName	Nama dokumen OpenAPI yang terkait dengan instans ini OpenApiOptions .
OpenApiVersion	Versi spesifikasi OpenAPI yang akan digunakan. Secara default menjadi OpenApi3_1.
ShouldInclude	Delegasi untuk menentukan apakah yang diberikan ApiDescription harus disertakan dalam dokumen OpenAPI yang diberikan.

Metode

Nama	Deskripsi
AddDocumentTransformer(Func<OpenApiDocument,OpenApiDocumentTransformerContext,CancellationToken,Task>)	Mendaftarkan delegasi tertentu sebagai transformator dokumen pada instans saat ini OpenApiOptions .
AddDocumentTransformer(IOpenApiDocumentTransformer)	Mendaftarkan instans tertentu pada IOpenApiDocumentTransformer instans saat ini OpenApiOptions .
AddDocumentTransformer<TTransformerType>()	Mendaftarkan transformator dokumen baru pada instans saat ini OpenApiOptions .
AddOperationTransformer(Func<OpenApiOperation,OpenApiOperationTransformerContext,CancellationToken,Task>)	Mendaftarkan delegasi tertentu sebagai transformator operasi pada instans saat ini OpenApiOptions .
AddOperationTransformer(IOpenApiOperationTransformer)	Mendaftarkan instans tertentu pada IOpenApiOperationTransformer instans saat ini OpenApiOptions .
AddOperationTransformer<TTransformerType>()	Mendaftarkan transformator operasi baru pada instans saat ini OpenApiOptions .
AddSchemaTransformer(Func<OpenApiSchema,OpenApiSchemaTransformerContext,CancellationToken,Task>)	Mendaftarkan delegasi tertentu sebagai transformator skema pada instans saat ini OpenApiOptions .
AddSchemaTransformer(IOpenApiSchemaTransformer)	Mendaftarkan instans tertentu pada IOpenApiOperationTransformer instans saat ini OpenApiOptions .
AddSchemaTransformer<TTransformerType>()	Mendaftarkan transformator skema baru pada instans saat ini OpenApiOptions .
CreateDefaultSchemaReferenceId(JsonTypeInfo)	Implementasi default untuk membuat ID referensi skema untuk .JsonTypeInfo