OpenApiOptions Klasa
Definicja
Ważne
Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.
Opcje obsługi budowy dokumentów OpenAPI.
public sealed class OpenApiOptionstype OpenApiOptions = classPublic NotInheritable Class OpenApiOptions- Dziedziczenie
-
OpenApiOptions
Konstruktory
| OpenApiOptions() |
Inicjuje nowe wystąpienie klasy OpenApiOptions z domyślnym predykatem ShouldInclude. |
Właściwości
| DocumentName |
Nazwa dokumentu OpenAPI skojarzonego z tym wystąpieniem OpenApiOptions. |
| OpenApiVersion |
Wersja specyfikacji interfejsu OpenAPI do użycia. Wartość domyślna to OpenApi3_0. |
| ShouldInclude |
Pełnomocnik do określenia, czy dany ApiDescription powinien zostać uwzględniony w danym dokumencie OpenAPI. |
Metody
| UseOperationTransformer(Func<OpenApiOperation,OpenApiOperationTransformerContext,CancellationToken,Task>) |
Rejestruje danego delegata jako transformator operacji w bieżącym wystąpieniu OpenApiOptions. |
| UseSchemaTransformer(Func<OpenApiSchema,OpenApiSchemaTransformerContext,CancellationToken,Task>) |
Rejestruje danego delegata jako transformator schematu w bieżącym wystąpieniu OpenApiOptions. |
| UseTransformer(Func<OpenApiDocument,OpenApiDocumentTransformerContext,CancellationToken,Task>) |
Rejestruje danego pełnomocnika jako transformatora dokumentu w bieżącym wystąpieniu OpenApiOptions. |
| UseTransformer(IOpenApiDocumentTransformer) |
Rejestruje dane wystąpienie IOpenApiDocumentTransformer w bieżącym wystąpieniu OpenApiOptions. |
| UseTransformer<TTransformerType>() |
Rejestruje nowy transformator dokumentu w bieżącym wystąpieniu OpenApiOptions. |