OpenApiEndpointConventionBuilderExtensions.WithOpenApi Metoda
Definice
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í.
Přetížení
WithOpenApi<TBuilder>(TBuilder) |
Přidá poznámku OpenAPI k Metadata přidružené k aktuálnímu koncovému bodu. |
WithOpenApi<TBuilder>(TBuilder, Func<OpenApiOperation,OpenApiOperation>) |
Přidá poznámku OpenAPI k Metadata přidružené k aktuálnímu koncovému bodu a upraví ji daným |
WithOpenApi<TBuilder>(TBuilder)
Přidá poznámku OpenAPI k Metadata přidružené k aktuálnímu koncovému bodu.
public static TBuilder WithOpenApi<TBuilder> (this TBuilder builder) where TBuilder : Microsoft.AspNetCore.Builder.IEndpointConventionBuilder;
static member WithOpenApi : 'Builder -> 'Builder (requires 'Builder :> Microsoft.AspNetCore.Builder.IEndpointConventionBuilder)
<Extension()>
Public Function WithOpenApi(Of TBuilder As IEndpointConventionBuilder) (builder As TBuilder) As TBuilder
Parametry typu
- TBuilder
Parametry
- builder
- TBuilder
Návraty
IEndpointConventionBuilder, který lze použít k dalšímu přizpůsobení koncového bodu.
Poznámky
Tato metoda se neintegruje s integrovanou podporou generování dokumentů OpenAPI v ASP.NET Core a primárně je určená pro spotřebu společně s Swashbuckle.AspNetCore.
Platí pro
WithOpenApi<TBuilder>(TBuilder, Func<OpenApiOperation,OpenApiOperation>)
Přidá poznámku OpenAPI k Metadata přidružené k aktuálnímu koncovému bodu a upraví ji daným configureOperation
.
public static TBuilder WithOpenApi<TBuilder> (this TBuilder builder, Func<Microsoft.OpenApi.Models.OpenApiOperation,Microsoft.OpenApi.Models.OpenApiOperation> configureOperation) where TBuilder : Microsoft.AspNetCore.Builder.IEndpointConventionBuilder;
static member WithOpenApi : 'Builder * Func<Microsoft.OpenApi.Models.OpenApiOperation, Microsoft.OpenApi.Models.OpenApiOperation> -> 'Builder (requires 'Builder :> Microsoft.AspNetCore.Builder.IEndpointConventionBuilder)
<Extension()>
Public Function WithOpenApi(Of TBuilder As IEndpointConventionBuilder) (builder As TBuilder, configureOperation As Func(Of OpenApiOperation, OpenApiOperation)) As TBuilder
Parametry typu
- TBuilder
Parametry
- builder
- TBuilder
- configureOperation
- Func<OpenApiOperation,OpenApiOperation>
Func<T,TResult>, která vrátí novou anotaci OpenAPI zadanou vygenerovanou operaci.
Návraty
IEndpointConventionBuilder, který lze použít k dalšímu přizpůsobení koncového bodu.
Poznámky
Tato metoda se neintegruje s integrovanou podporou generování dokumentů OpenAPI v ASP.NET Core a primárně je určená pro spotřebu společně s Swashbuckle.AspNetCore.