HttpMethodAttribute Class

Reference

Definition

Namespace:: Microsoft.AspNetCore.Mvc.Routing

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

Source:: HttpMethodAttribute.cs

Source:: HttpMethodAttribute.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.

Identifies an action that supports a given set of HTTP methods.

public ref class HttpMethodAttribute abstract : Attribute, Microsoft::AspNetCore::Mvc::Routing::IActionHttpMethodProvider, Microsoft::AspNetCore::Mvc::Routing::IRouteTemplateProvider

[System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=true, Inherited=true)]
public abstract class HttpMethodAttribute : Attribute, Microsoft.AspNetCore.Mvc.Routing.IActionHttpMethodProvider, Microsoft.AspNetCore.Mvc.Routing.IRouteTemplateProvider

[<System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=true, Inherited=true)>]
type HttpMethodAttribute = class
    inherit Attribute
    interface IActionHttpMethodProvider
    interface IRouteTemplateProvider

Public MustInherit Class HttpMethodAttribute
Inherits Attribute
Implements IActionHttpMethodProvider, IRouteTemplateProvider

Inheritance: Attribute
HttpMethodAttribute

Derived: Microsoft.AspNetCore.Mvc.HttpDeleteAttribute

Microsoft.AspNetCore.Mvc.HttpGetAttribute

Microsoft.AspNetCore.Mvc.HttpHeadAttribute

Microsoft.AspNetCore.Mvc.HttpOptionsAttribute

Microsoft.AspNetCore.Mvc.HttpPatchAttribute

More…

Attributes: AttributeUsageAttribute

Implements: IActionHttpMethodProvider IRouteTemplateProvider

Constructors

HttpMethodAttribute(IEnumerable<String>)	Creates a new HttpMethodAttribute with the given set of HTTP methods.
HttpMethodAttribute(IEnumerable<String>, String)	Creates a new HttpMethodAttribute with the given set of HTTP methods an the given route template.

Properties

HttpMethods	The list of http methods this action provider supports.
Name	Gets the route name. The route name can be used to generate a link using a specific route, instead of relying on selection of a route based on the given set of route values.
Order	Gets the route order. The order determines the order of route execution. Routes with a lower order value are tried first. When a route doesn't specify a value, it gets the value of the Order or a default value of 0 if the RouteAttribute doesn't define a value on the controller.
Template	The route template. May be `null`.

Explicit Interface Implementations

IRouteTemplateProvider.Order

Gets the route order. The order determines the order of route execution. Routes with a lower order value are tried first. When a route doesn't specify a value, it gets a default value of 0. A null value for the Order property means that the user didn't specify an explicit order for the route.

Applies to