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

Производный: Microsoft.AspNetCore.Mvc.ProducesAttribute<T>

Атрибуты: 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)	Настраивает коллекцию разрешенных типов контента, которые могут быть созданы действием .

Применяется к

Поделиться через