ProducesAttribute Klasse

Referenz

Definition

Namespace:: Microsoft.AspNetCore.Mvc

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

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

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

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

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

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

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

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

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

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

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

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

Paket:: Microsoft.AspNetCore.App.Ref v9.0.0-rc.2.24474.3

Quelle:: ProducesAttribute.cs

Quelle:: ProducesAttribute.cs

Quelle:: ProducesAttribute.cs

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Ein Filter, der die erwartete Type Rückgabe der Aktion und die unterstützten Antwortinhaltstypen angibt. Der ContentTypes Wert wird verwendet, um festzulegen 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

Vererbung: Attribute

ResultFilterAttribute
ProducesAttribute

Vererbung: Attribute
ProducesAttribute

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

Attribute: AttributeUsageAttribute

Implementiert: IApiResponseMetadataProvider IFilterMetadata IOrderedFilter IResultFilter

Konstruktoren

ProducesAttribute(String, String[])	Initialisiert eine instance von ProducesAttribute mit zulässigen Inhaltstypen.
ProducesAttribute(Type)	Initialisiert eine Instanz von ProducesAttribute.

Eigenschaften

ContentTypes	Ruft die unterstützten Antwortinhaltstypen ab oder legt sie fest. Wird verwendet, um festzulegen ContentTypes.
Order	Ruft den Wert der Reihenfolge zum Bestimmen der Ausführungsreihenfolge von Filtern ab. Filter werden im aufsteigenden numerischen Wert der Order Eigenschaft ausgeführt.
Order	Ruft den Wert der Reihenfolge zum Bestimmen der Ausführungsreihenfolge von Filtern ab. Filter werden im aufsteigenden numerischen Wert der Order Eigenschaft ausgeführt. (Geerbt von ResultFilterAttribute)
StatusCode	Ruft den HTTP-status Code der Antwort ab.
Type	Ruft den optimistischen Rückgabetyp der Aktion ab.

Methoden

OnResultExecuted(ResultExecutedContext)	Wird aufgerufen, nachdem das Aktionsergebnis ausgeführt wurde.
OnResultExecuted(ResultExecutedContext)	Wird aufgerufen, nachdem das Aktionsergebnis ausgeführt wurde. (Geerbt von ResultFilterAttribute)
OnResultExecuting(ResultExecutingContext)	Wird aufgerufen, bevor das Aktionsergebnis ausgeführt wird.
OnResultExecutionAsync(ResultExecutingContext, ResultExecutionDelegate)	Wird vor dem Aktionsergebnis asynchron aufgerufen. (Geerbt von ResultFilterAttribute)
SetContentTypes(MediaTypeCollection)	Konfiguriert eine Auflistung zulässiger Inhaltstypen, die von der Aktion erstellt werden können.

Gilt für:

Freigeben über