ProducesAttribute クラス

  • リファレンス

定義

名前空間:
Microsoft.AspNetCore.Mvc
アセンブリ:
Microsoft.AspNetCore.Mvc.Core.dll
パッケージ:
Microsoft.AspNetCore.Mvc.Core v1.0.0
パッケージ:
Microsoft.AspNetCore.Mvc.Core v1.1.0
パッケージ:
Microsoft.AspNetCore.Mvc.Core v2.0.0
パッケージ:
Microsoft.AspNetCore.Mvc.Core v2.1.0
パッケージ:
Microsoft.AspNetCore.Mvc.Core v2.2.0
パッケージ:
Microsoft.AspNetCore.App.Ref v3.0.1
パッケージ:
Microsoft.AspNetCore.App.Ref v3.1.10
パッケージ:
Microsoft.AspNetCore.App.Ref v5.0.0
パッケージ:
Microsoft.AspNetCore.App.Ref v6.0.6
パッケージ:
Microsoft.AspNetCore.App.Ref v7.0.5
パッケージ:
Microsoft.AspNetCore.App.Ref v8.0.0
パッケージ:
Microsoft.AspNetCore.App.Ref v9.0.0-rc.2.24474.3
ソース:
ProducesAttribute.cs
ソース:
ProducesAttribute.cs
ソース:
ProducesAttribute.cs

アクションが返す予期される Type 内容と、サポートされている応答コンテンツ タイプを指定するフィルター。 値は ContentTypes を設定 ContentTypesするために使用されます。

public ref class ProducesAttribute : Microsoft::AspNetCore::Mvc::Filters::ResultFilterAttribute, Microsoft::AspNetCore::Mvc::ApiExplorer::IApiResponseMetadataProvider
public ref class ProducesAttribute : Attribute, Microsoft::AspNetCore::Mvc::ApiExplorer::IApiResponseMetadataProvider, Microsoft::AspNetCore::Mvc::Filters::IOrderedFilter, Microsoft::AspNetCore::Mvc::Filters::IResultFilter
[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Method, AllowMultiple=false, Inherited=true)]
public class ProducesAttribute : Microsoft.AspNetCore.Mvc.Filters.ResultFilterAttribute, Microsoft.AspNetCore.Mvc.ApiExplorer.IApiResponseMetadataProvider
[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Method, AllowMultiple=false, Inherited=true)]
public class ProducesAttribute : Attribute, Microsoft.AspNetCore.Mvc.ApiExplorer.IApiResponseMetadataProvider, Microsoft.AspNetCore.Mvc.Filters.IOrderedFilter, Microsoft.AspNetCore.Mvc.Filters.IResultFilter
[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Method, AllowMultiple=false, Inherited=true)>]
type ProducesAttribute = class
    inherit ResultFilterAttribute
    interface IApiResponseMetadataProvider
[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Method, AllowMultiple=false, Inherited=true)>]
type ProducesAttribute = class
    inherit ResultFilterAttribute
    interface IApiResponseMetadataProvider
    interface IFilterMetadata
[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Method, AllowMultiple=false, Inherited=true)>]
type ProducesAttribute = class
    inherit Attribute
    interface IResultFilter
    interface IFilterMetadata
    interface IOrderedFilter
    interface IApiResponseMetadataProvider
[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Method, AllowMultiple=false, Inherited=true)>]
type ProducesAttribute = class
    inherit Attribute
    interface IApiResponseMetadataProvider
    interface IFilterMetadata
    interface IOrderedFilter
    interface IResultFilter
Public Class ProducesAttribute
Inherits ResultFilterAttribute
Implements IApiResponseMetadataProvider
Public Class ProducesAttribute
Inherits Attribute
Implements IApiResponseMetadataProvider, IOrderedFilter, IResultFilter
継承
Attribute
ResultFilterAttribute
ProducesAttribute
継承
Attribute
ProducesAttribute
派生
属性
AttributeUsageAttribute
実装
IApiResponseMetadataProvider IFilterMetadata IOrderedFilter IResultFilter

コンストラクター

ProducesAttribute(String, String[])

許可されたコンテンツ タイプを使用して の ProducesAttribute インスタンスを初期化します。
ProducesAttribute(Type)

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

プロパティ

ContentTypes

サポートされている応答コンテンツ タイプを取得または設定します。 を設定 ContentTypesするために使用されます。
Order

フィルターの実行順序を決定するための順序値を取得します。 フィルターは、 プロパティの昇順の数値で Order 実行されます。
Order

フィルターの実行順序を決定するための順序値を取得します。 フィルターは、 プロパティの昇順の数値で Order 実行されます。

(継承元 ResultFilterAttribute)
StatusCode

応答の HTTP 状態コードを取得します。
Type

アクションのオプティミスティック戻り値の型を取得します。

メソッド

OnResultExecuted(ResultExecutedContext)

アクションの結果の実行後に呼び出されます。
OnResultExecuted(ResultExecutedContext)

アクションの結果の実行後に呼び出されます。

(継承元 ResultFilterAttribute)
OnResultExecuting(ResultExecutingContext)

アクション結果の実行前に呼び出されます。
OnResultExecutionAsync(ResultExecutingContext, ResultExecutionDelegate)

アクションの結果の前に非同期的に呼び出されます。

(継承元 ResultFilterAttribute)
SetContentTypes(MediaTypeCollection)

アクションによって生成できる許可されるコンテンツ タイプのコレクションを構成します。

適用対象