OpenApiOptions Klasse
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Optionen zur Unterstützung der Erstellung von OpenAPI-Dokumenten.
public sealed class OpenApiOptionstype OpenApiOptions = classPublic NotInheritable Class OpenApiOptions- Vererbung
-
OpenApiOptions
Konstruktoren
| OpenApiOptions() |
Initialisiert eine neue Instanz der OpenApiOptions Klasse mit dem Standard-ShouldInclude Prädikat. |
Eigenschaften
| DocumentName |
Der Name des OpenAPI-Dokuments, dem diese OpenApiOptions Instanz zugeordnet ist. |
| OpenApiVersion |
Die Version der zu verwendenden OpenAPI-Spezifikation. Standardmäßig wird OpenApi3_0. |
| ShouldInclude |
Eine Stellvertretung, um zu bestimmen, ob eine bestimmte ApiDescription in das angegebene OpenAPI-Dokument aufgenommen werden soll. |
Methoden
| UseOperationTransformer(Func<OpenApiOperation,OpenApiOperationTransformerContext,CancellationToken,Task>) |
Registriert einen bestimmten Delegaten als Betriebstransformor für die aktuelle OpenApiOptions Instanz. |
| UseSchemaTransformer(Func<OpenApiSchema,OpenApiSchemaTransformerContext,CancellationToken,Task>) |
Registriert einen bestimmten Delegat als Schematransformator für die aktuelle OpenApiOptions Instanz. |
| UseTransformer(Func<OpenApiDocument,OpenApiDocumentTransformerContext,CancellationToken,Task>) |
Registriert einen bestimmten Delegat als Dokumenttransformator für die aktuelle OpenApiOptions Instanz. |
| UseTransformer(IOpenApiDocumentTransformer) |
Registriert eine bestimmte Instanz von IOpenApiDocumentTransformer für die aktuelle OpenApiOptions Instanz. |
| UseTransformer<TTransformerType>() |
Registriert einen neuen Dokumenttransformator für die aktuelle OpenApiOptions Instanz. |