ProducesAttribute Classe

Referência

Definição

Namespace:: Microsoft.AspNetCore.Mvc

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

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

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

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

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

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

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

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

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

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

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

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

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Um filtro que especifica o esperado Type que a ação retornará e os tipos de conteúdo de resposta com suporte. O ContentTypes valor é usado para definir 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

Herança: Attribute

ResultFilterAttribute
ProducesAttribute

Herança: Attribute
ProducesAttribute

Derivado: Microsoft.AspNetCore.Mvc.ProducesAttribute<T>

Atributos: AttributeUsageAttribute

Implementações: IApiResponseMetadataProvider IFilterMetadata IOrderedFilter IResultFilter

Construtores

ProducesAttribute(String, String[])	Inicializa uma instância do com tipos de ProducesAttribute conteúdo permitidos.
ProducesAttribute(Type)	Inicializa uma instância de ProducesAttribute.

Propriedades

ContentTypes	Obtém ou define os tipos de conteúdo de resposta com suporte. Usado para definir ContentTypes.
Order	Obtém o valor da ordem para determinar a ordem de execução de filtros. Os filtros são executados no valor numérico crescente da Order propriedade .
Order	Obtém o valor da ordem para determinar a ordem de execução de filtros. Os filtros são executados no valor numérico crescente da Order propriedade . (Herdado de ResultFilterAttribute)
StatusCode	Obtém o código de status HTTP da resposta.
Type	Obtém o tipo de retorno otimista da ação.

Métodos

OnResultExecuted(ResultExecutedContext)	Chamado após o resultado da ação ser executado.
OnResultExecuted(ResultExecutedContext)	Chamado após o resultado da ação ser executado. (Herdado de ResultFilterAttribute)
OnResultExecuting(ResultExecutingContext)	Chamado antes de o resultado da ação ser executado.
OnResultExecutionAsync(ResultExecutingContext, ResultExecutionDelegate)	Chamado de forma assíncrona antes do resultado da ação. (Herdado de ResultFilterAttribute)
SetContentTypes(MediaTypeCollection)	Configura uma coleção de tipos de conteúdo permitidos que podem ser produzidos pela ação.

Aplica-se a