OpenApiOptions Třída

Reference

Definice

Obor názvů:: Microsoft.AspNetCore.OpenApi

Sestavení:: Microsoft.AspNetCore.OpenApi.dll

Balíček:: Microsoft.AspNetCore.OpenApi v9.0.0

Zdroj:: OpenApiOptions.cs

Důležité

Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.

Možnosti podpory vytváření dokumentů OpenAPI

public sealed class OpenApiOptions

type OpenApiOptions = class

Public NotInheritable Class OpenApiOptions

Dědičnost: Object
OpenApiOptions

Konstruktory

OpenApiOptions()

Inicializuje novou instanci třídy OpenApiOptions s výchozí ShouldInclude predikát.

Vlastnosti

CreateSchemaReferenceId	Delegát, který určí, jak se mají vytvořit referenční ID pro schémata přidružená k typům v daném dokumentu OpenAPI.
DocumentName	Název dokumentu OpenAPI, ke které je přidružena tato instance OpenApiOptions.
OpenApiVersion	Verze specifikace OpenAPI, která se má použít. Výchozí hodnota je OpenApi3_0.
ShouldInclude	Delegát, který určí, zda má být daná ApiDescription zahrnuta do daného dokumentu OpenAPI.

Metody

AddDocumentTransformer(Func<OpenApiDocument,OpenApiDocumentTransformerContext,CancellationToken,Task>)	Zaregistruje daného delegáta jako transformátor dokumentu na aktuální instanci OpenApiOptions.
AddDocumentTransformer(IOpenApiDocumentTransformer)	Zaregistruje danou instanci IOpenApiDocumentTransformer v aktuální instanci OpenApiOptions.
AddDocumentTransformer<TTransformerType>()	Zaregistruje nový transformátor dokumentu na aktuální instanci OpenApiOptions.
AddOperationTransformer(Func<OpenApiOperation,OpenApiOperationTransformerContext,CancellationToken,Task>)	Zaregistruje daného delegáta jako transformátor operace na aktuální instanci OpenApiOptions.
AddOperationTransformer(IOpenApiOperationTransformer)	Zaregistruje danou instanci IOpenApiOperationTransformer v aktuální instanci OpenApiOptions.
AddOperationTransformer<TTransformerType>()	Zaregistruje nový transformátor operace na aktuální instanci OpenApiOptions.
AddSchemaTransformer(Func<OpenApiSchema,OpenApiSchemaTransformerContext,CancellationToken,Task>)	Zaregistruje daného delegáta jako transformátor schématu v aktuální instanci OpenApiOptions.
AddSchemaTransformer(IOpenApiSchemaTransformer)	Zaregistruje danou instanci IOpenApiOperationTransformer v aktuální instanci OpenApiOptions.
AddSchemaTransformer<TTransformerType>()	Zaregistruje nový transformátor schématu v aktuální instanci OpenApiOptions.
CreateDefaultSchemaReferenceId(JsonTypeInfo)	Výchozí implementace pro vytvoření ID odkazu schématu pro danou JsonTypeInfo.

Platí pro

Sdílet prostřednictvím