OpenApiEndpointConventionBuilderExtensions.WithOpenApi メソッド

定義

名前空間:

Microsoft.AspNetCore.Builder

アセンブリ:

Microsoft.AspNetCore.OpenApi.dll

パッケージ:

Microsoft.AspNetCore.OpenApi v8.0.0

オーバーロード

WithOpenApi<TBuilder>(TBuilder)	現在のエンドポイントに関連付けられている Metadata に OpenAPI 注釈を追加します。
WithOpenApi<TBuilder>(TBuilder, Func<OpenApiOperation,OpenApiOperation>)	現在のエンドポイントに関連付けられている Metadata に OpenAPI 注釈を追加し、指定された configureOperationで変更します。

WithOpenApi<TBuilder>(TBuilder)

ソース:

OpenApiEndpointConventionBuilderExtensions.cs

現在のエンドポイントに関連付けられている Metadata に OpenAPI 注釈を追加します。

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。

注釈

このメソッドは、ASP.NET Core の組み込みの OpenAPI ドキュメント生成サポートとは統合されず、主にサイド Swashbuckle.AspNetCore と共に使用することを目的としています。

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

ソース:

OpenApiEndpointConventionBuilderExtensions.cs

現在のエンドポイントに関連付けられている Metadata に OpenAPI 注釈を追加し、指定された 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>

生成された操作で新しい OpenAPI 注釈を返す Func<T,TResult>。

戻り値

TBuilder

エンドポイントをさらにカスタマイズするために使用できる IEndpointConventionBuilder。

注釈

このメソッドは、ASP.NET Core の組み込みの OpenAPI ドキュメント生成サポートとは統合されず、主にサイド Swashbuckle.AspNetCore と共に使用することを目的としています。