ProducesAttribute クラス

定義

名前空間:

Microsoft.AspNetCore.Mvc

アセンブリ:

Microsoft.AspNetCore.Mvc.Core.dll

パッケージ:

Microsoft.AspNetCore.App.Ref v8.0.0

ソース:

ProducesAttribute.cs

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

[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 Attribute
    interface IResultFilter
    interface IFilterMetadata
    interface IOrderedFilter
    interface IApiResponseMetadataProvider

Public Class ProducesAttribute
Inherits Attribute
Implements IApiResponseMetadataProvider, IOrderedFilter, IResultFilter

継承

Attribute

ProducesAttribute

派生

Microsoft.AspNetCore.Mvc.ProducesAttribute<T>

属性

AttributeUsageAttribute

実装

IApiResponseMetadataProvider IFilterMetadata IOrderedFilter IResultFilter

コンストラクター

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

プロパティ

ContentTypes	サポートされている応答コンテンツ タイプを取得または設定します。 を設定 ContentTypesするために使用されます。
Order	フィルターの実行順序を決定するための順序値を取得します。 フィルターは、 プロパティの昇順の数値で Order 実行されます。
StatusCode	応答の HTTP 状態コードを取得します。
Type	アクションのオプティミスティック戻り値の型を取得します。

メソッド

OnResultExecuted(ResultExecutedContext)	アクションの結果の実行後に呼び出されます。
OnResultExecuting(ResultExecutingContext)	アクション結果の実行前に呼び出されます。
SetContentTypes(MediaTypeCollection)	アクションによって生成できる許可されるコンテンツ タイプのコレクションを構成します。