EndpointDescriptionAttribute クラス

定義

名前空間:
Microsoft.AspNetCore.Http
アセンブリ:
Microsoft.AspNetCore.Http.Extensions.dll
パッケージ:
Microsoft.AspNetCore.App.Ref v10.0.0-preview.6.25358.103
パッケージ:
Microsoft.AspNetCore.App.Ref v7.0.5
パッケージ:
Microsoft.AspNetCore.App.Ref v8.0.0
パッケージ:
Microsoft.AspNetCore.App.Ref v9.0.2
ソース:
EndpointDescriptionAttribute.cs

で Metadataエンドポイントの説明を指定します。

[System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=false, Inherited=false)]
public sealed class EndpointDescriptionAttribute : Attribute, Microsoft.AspNetCore.Http.Metadata.IEndpointDescriptionMetadata
[<System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=false, Inherited=false)>]
type EndpointDescriptionAttribute = class
    inherit Attribute
    interface IEndpointDescriptionMetadata
Public NotInheritable Class EndpointDescriptionAttribute
Inherits Attribute
Implements IEndpointDescriptionMetadata
継承
Attribute
EndpointDescriptionAttribute
属性
AttributeUsageAttribute
実装
IEndpointDescriptionMetadata

注釈

OpenAPI 仕様では、動作の詳細な複数行記述子を使用してエンドポイントに注釈を付けるために使用できる操作とパラメーターに関する description 属性がサポートされています。

コンストラクター

名前 説明
EndpointDescriptionAttribute(String)

EndpointDescriptionAttribute のインスタンスを初期化します。

プロパティ

名前 説明
Description

エンドポイントに関連付けられている説明を取得します。

メソッド

名前 説明
ToString()

で Metadataエンドポイントの説明を指定します。

適用対象