OpenApiEndpointConventionBuilderExtensions.WithOpenApi Метод

Определение

Пространство имен:

Microsoft.AspNetCore.Builder

Сборка:

Microsoft.AspNetCore.OpenApi.dll

Пакет:

Microsoft.AspNetCore.OpenApi v8.0.0

Перегрузки

WithOpenApi<TBuilder>(TBuilder)	Добавляет заметку OpenAPI к Metadata, связанной с текущей конечной точкой.
WithOpenApi<TBuilder>(TBuilder, Func<OpenApiOperation,OpenApiOperation>)	Добавляет заметку OpenAPI в Metadata, связанную с текущей конечной точкой, и изменяет ее с заданным configureOperation.

WithOpenApi<TBuilder>(TBuilder)

Исходный код:

OpenApiEndpointConventionBuilderExtensions.cs

Добавляет заметку OpenAPI к Metadata, связанной с текущей конечной точкой.

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

Параметры типа

TBuilder

Параметры

builder

TBuilder

IEndpointConventionBuilder.

Возвращаемое значение

TBuilder

IEndpointConventionBuilder, которые можно использовать для дальнейшей настройки конечной точки.

Комментарии

Этот метод не интегрируется со встроенной поддержкой создания документов OpenAPI в ASP.NET Core и предназначен в основном для использования на стороне Swashbuckle.AspNetCore.

WithOpenApi<TBuilder>(TBuilder, Func<OpenApiOperation,OpenApiOperation>)

Исходный код:

OpenApiEndpointConventionBuilderExtensions.cs

Добавляет заметку OpenAPI в Metadata, связанную с текущей конечной точкой, и изменяет ее с заданным 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

Параметры типа

TBuilder

Параметры

builder

TBuilder

IEndpointConventionBuilder.

configureOperation

Func<OpenApiOperation,OpenApiOperation>

Func<T,TResult>, который возвращает новую заметку OpenAPI при выполнении созданной операции.

Возвращаемое значение

TBuilder

IEndpointConventionBuilder, которые можно использовать для дальнейшей настройки конечной точки.

Комментарии

Этот метод не интегрируется со встроенной поддержкой создания документов OpenAPI в ASP.NET Core и предназначен в основном для использования на стороне Swashbuckle.AspNetCore.