Freigeben über


OpenApiOptions Klasse

Definition

Optionen zur Unterstützung der Erstellung von OpenAPI-Dokumenten.

public sealed class OpenApiOptions
type OpenApiOptions = class
Public NotInheritable Class OpenApiOptions
Vererbung
OpenApiOptions

Konstruktoren

Name Beschreibung
OpenApiOptions()

Initialisiert eine neue Instanz der OpenApiOptions Klasse mit dem Standard-Prädikat ShouldInclude .

Eigenschaften

Name Beschreibung
CreateSchemaReferenceId

Ein Delegat, um zu bestimmen, wie Referenz-IDs für Schemas erstellt werden sollen, die typen im angegebenen OpenAPI-Dokument zugeordnet sind.

DocumentName

Der Name des OpenAPI-Dokuments, dem diese OpenApiOptions Instanz zugeordnet ist.

OpenApiVersion

Die Version der zu verwendenden OpenAPI-Spezifikation. Wird standardmäßig auf OpenApi3_1 festgelegt.

ShouldInclude

Eine Stellvertretung, um zu bestimmen, ob ein gegebenes ApiDescription Element im angegebenen OpenAPI-Dokument enthalten sein soll.

Methoden

Name Beschreibung
AddDocumentTransformer(Func<OpenApiDocument,OpenApiDocumentTransformerContext,CancellationToken,Task>)

Registriert einen bestimmten Delegaten als Dokumenttransformator für die aktuelle OpenApiOptions Instanz.

AddDocumentTransformer(Func<OpenApiDocument,OpenApiDocumentTransformerContext,CancellationToken,Task>)

Registriert einen bestimmten Delegaten als Dokumenttransformator für die aktuelle OpenApiOptions Instanz.

AddDocumentTransformer(IOpenApiDocumentTransformer)

Registriert eine bestimmte Instanz der IOpenApiDocumentTransformer aktuellen OpenApiOptions Instanz.

AddDocumentTransformer<TTransformerType>()

Registriert einen neuen Dokumenttransformator für die aktuelle OpenApiOptions Instanz.

AddOperationTransformer(Func<OpenApiOperation,OpenApiOperationTransformerContext,CancellationToken,Task>)

Registriert einen bestimmten Delegaten als Betriebstransformor für die aktuelle OpenApiOptions Instanz.

AddOperationTransformer(Func<OpenApiOperation,OpenApiOperationTransformerContext,CancellationToken,Task>)

Registriert einen bestimmten Delegaten als Betriebstransformor für die aktuelle OpenApiOptions Instanz.

AddOperationTransformer(IOpenApiOperationTransformer)

Registriert eine bestimmte Instanz der IOpenApiOperationTransformer aktuellen OpenApiOptions Instanz.

AddOperationTransformer<TTransformerType>()

Registriert einen neuen Betriebstransformator für die aktuelle OpenApiOptions Instanz.

AddSchemaTransformer(Func<OpenApiSchema,OpenApiSchemaTransformerContext,CancellationToken,Task>)

Registriert einen bestimmten Delegaten als Schematransformator für die aktuelle OpenApiOptions Instanz.

AddSchemaTransformer(Func<OpenApiSchema,OpenApiSchemaTransformerContext,CancellationToken,Task>)

Registriert einen bestimmten Delegaten als Schematransformator für die aktuelle OpenApiOptions Instanz.

AddSchemaTransformer(IOpenApiSchemaTransformer)

Registriert eine bestimmte Instanz der IOpenApiOperationTransformer aktuellen OpenApiOptions Instanz.

AddSchemaTransformer<TTransformerType>()

Registriert einen neuen Schematransformator für die aktuelle OpenApiOptions Instanz.

CreateDefaultSchemaReferenceId(JsonTypeInfo)

Eine Standardimplementierung zum Erstellen einer Schemareferenz-ID für eine bestimmte .JsonTypeInfo

Gilt für: