ProducesResponseTypeAttribute Class

Reference

Definition

Namespace:: Microsoft.AspNetCore.Mvc

Assembly:: Microsoft.AspNetCore.Mvc.Core.dll

Package:: Microsoft.AspNetCore.Mvc.Core v1.0.0

Package:: Microsoft.AspNetCore.Mvc.Core v1.1.0

Package:: Microsoft.AspNetCore.Mvc.Core v2.0.0

Package:: Microsoft.AspNetCore.Mvc.Core v2.1.0

Package:: Microsoft.AspNetCore.Mvc.Core v2.2.0

Package:: Microsoft.AspNetCore.App.Ref v3.0.1

Package:: Microsoft.AspNetCore.App.Ref v3.1.10

Package:: Microsoft.AspNetCore.App.Ref v5.0.0

Package:: Microsoft.AspNetCore.App.Ref v6.0.6

Package:: Microsoft.AspNetCore.App.Ref v7.0.5

Package:: Microsoft.AspNetCore.App.Ref v8.0.0

Package:: Microsoft.AspNetCore.App.Ref v9.0.0

Source:: ProducesResponseTypeAttribute.cs

Source:: ProducesResponseTypeAttribute.cs

Source:: ProducesResponseTypeAttribute.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A filter that specifies the type of the value and status code returned by the action.

public ref class ProducesResponseTypeAttribute : Attribute, Microsoft::AspNetCore::Mvc::ApiExplorer::IApiResponseMetadataProvider, Microsoft::AspNetCore::Mvc::Filters::IFilterMetadata

[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Method, AllowMultiple=true, Inherited=true)]
public class ProducesResponseTypeAttribute : Attribute, Microsoft.AspNetCore.Mvc.ApiExplorer.IApiResponseMetadataProvider, Microsoft.AspNetCore.Mvc.Filters.IFilterMetadata

[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Method, AllowMultiple=true, Inherited=true)>]
type ProducesResponseTypeAttribute = class
    inherit Attribute
    interface IApiResponseMetadataProvider
    interface IFilterMetadata

Public Class ProducesResponseTypeAttribute
Inherits Attribute
Implements IApiResponseMetadataProvider, IFilterMetadata

Inheritance: Attribute
ProducesResponseTypeAttribute

Derived: Microsoft.AspNetCore.Mvc.ProducesResponseTypeAttribute<T>

Attributes: AttributeUsageAttribute

Implements: IApiResponseMetadataProvider IFilterMetadata

Constructors

ProducesResponseTypeAttribute(Int32)	Initializes an instance of ProducesResponseTypeAttribute.
ProducesResponseTypeAttribute(Type, Int32, String, String[])	Initializes an instance of ProducesResponseTypeAttribute.
ProducesResponseTypeAttribute(Type, Int32)	Initializes an instance of ProducesResponseTypeAttribute.

Properties

StatusCode	Gets or sets the HTTP status code of the response.
Type	Gets or sets the type of the value returned by an action.

Explicit Interface Implementations

IApiResponseMetadataProvider.SetContentTypes(MediaTypeCollection)

Configures a collection of allowed content types which can be produced by the action.

Applies to

Share via