ApiConventionMethodAttribute Class

  • Reference

Definition

Namespace:
Microsoft.AspNetCore.Mvc
Assembly:
Microsoft.AspNetCore.Mvc.Core.dll
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-rc.2.24474.3
Source:
ApiConventionMethodAttribute.cs
Source:
ApiConventionMethodAttribute.cs

API conventions to be applied to a controller action.

API conventions are used to influence the output of ApiExplorer. ApiConventionMethodAttribute can be used to specify an exact convention method that applies to an action. ApiConventionTypeAttribute for details about applying conventions at the assembly or controller level. 

public ref class ApiConventionMethodAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=false, Inherited=true)]
public sealed class ApiConventionMethodAttribute : Attribute
[<System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=false, Inherited=true)>]
type ApiConventionMethodAttribute = class
    inherit Attribute
Public NotInheritable Class ApiConventionMethodAttribute
Inherits Attribute
Inheritance
Attribute
ApiConventionMethodAttribute
Attributes
AttributeUsageAttribute

Constructors

ApiConventionMethodAttribute(Type, String)

Initializes an ApiConventionMethodAttribute instance using conventionType and the specified methodName.

Properties

ConventionType

Gets the convention type.

Applies to