OpenApiOptions Klasa

Definicja

Przestrzeń nazw:: Microsoft.AspNetCore.OpenApi

Zestaw:: Microsoft.AspNetCore.OpenApi.dll

Pakiet:: Microsoft.AspNetCore.OpenApi v10.0.0

Pakiet:: Microsoft.AspNetCore.OpenApi v11.0.0-preview.5.26302.115

Pakiet:: Microsoft.AspNetCore.OpenApi v9.0.8

Źródło:: OpenApiOptions.cs

Źródło:: OpenApiOptions.cs

Źródło:: OpenApiOptions.cs

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 OpenApiOptions

type OpenApiOptions = class

Public NotInheritable Class OpenApiOptions

Dziedziczenie: Object
OpenApiOptions

Konstruktory

Nazwa	Opis
OpenApiOptions()	Inicjuje nowe wystąpienie OpenApiOptions klasy z domyślnym ShouldInclude predykatem.

Właściwości

Nazwa	Opis
CreateSchemaReferenceId	Delegat określający sposób tworzenia identyfikatorów odwołań dla schematów skojarzonych z typami w danym dokumencie OpenAPI.
DocumentName	Nazwa dokumentu OpenAPI, OpenApiOptions z tym wystąpieniem jest skojarzone.
OpenApiVersion	Wersja specyfikacji interfejsu OpenAPI do użycia. Wartość domyślna to OpenApi3_1.
ShouldInclude	Pełnomocnik do określenia, czy dany ApiDescription element powinien być uwzględniony w danym dokumencie OpenAPI.

Metody

Nazwa	Opis
AddDocumentTransformer(Func<OpenApiDocument,OpenApiDocumentTransformerContext,CancellationToken,Task>)	Rejestruje danego delegata jako transformatora dokumentu w bieżącym OpenApiOptions wystąpieniu.
AddDocumentTransformer(Func<OpenApiDocument,OpenApiDocumentTransformerContext,CancellationToken,Task>)	Rejestruje danego delegata jako transformatora dokumentu w bieżącym OpenApiOptions wystąpieniu.
AddDocumentTransformer(IOpenApiDocumentTransformer)	Rejestruje dane wystąpienie IOpenApiDocumentTransformer w bieżącym OpenApiOptions wystąpieniu.
AddDocumentTransformer<TTransformerType>()	Rejestruje nowy transformator dokumentu w bieżącym OpenApiOptions wystąpieniu.
AddOperationTransformer(Func<OpenApiOperation,OpenApiOperationTransformerContext,CancellationToken,Task>)	Rejestruje danego delegata jako transformator operacji w bieżącym OpenApiOptions wystąpieniu.
AddOperationTransformer(Func<OpenApiOperation,OpenApiOperationTransformerContext,CancellationToken,Task>)	Rejestruje danego delegata jako transformator operacji w bieżącym OpenApiOptions wystąpieniu.
AddOperationTransformer(IOpenApiOperationTransformer)	Rejestruje dane wystąpienie IOpenApiOperationTransformer w bieżącym OpenApiOptions wystąpieniu.
AddOperationTransformer<TTransformerType>()	Rejestruje nowy transformator operacji w bieżącym OpenApiOptions wystąpieniu.
AddSchemaTransformer(Func<OpenApiSchema,OpenApiSchemaTransformerContext,CancellationToken,Task>)	Rejestruje danego delegata jako transformator schematu w bieżącym OpenApiOptions wystąpieniu.
AddSchemaTransformer(Func<OpenApiSchema,OpenApiSchemaTransformerContext,CancellationToken,Task>)	Rejestruje danego delegata jako transformator schematu w bieżącym OpenApiOptions wystąpieniu.
AddSchemaTransformer(IOpenApiSchemaTransformer)	Rejestruje dane wystąpienie IOpenApiOperationTransformer w bieżącym OpenApiOptions wystąpieniu.
AddSchemaTransformer<TTransformerType>()	Rejestruje nowy transformator schematu w bieżącym OpenApiOptions wystąpieniu.
CreateDefaultSchemaReferenceId(JsonTypeInfo)	Domyślna implementacja tworzenia identyfikatora odwołania schematu dla danego JsonTypeInfoelementu .

Dotyczy

Opinia

Czy ta strona była pomocna?