ApiConventionNameMatchBehavior Enum

  • Reference

Definition

Namespace:
Microsoft.AspNetCore.Mvc.ApiExplorer
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:
ApiConventionNameMatchBehavior.cs

The behavior for matching the name of a convention parameter or method.

public enum class ApiConventionNameMatchBehavior
public enum ApiConventionNameMatchBehavior
type ApiConventionNameMatchBehavior = 
Public Enum ApiConventionNameMatchBehavior
Inheritance
Enum
ApiConventionNameMatchBehavior

Fields

Name Value Description
Any 0

Matches any name. Use this if the parameter does not need to be matched.
Exact 1

The parameter or method name must exactly match the convention.
Prefix 2

The parameter or method name in the convention is a proper prefix.

Casing is used to delineate words in a given name. For instance, with this behavior the convention name "Get" will match "Get", "GetPerson" or "GetById", but not "getById", "Getaway".

Suffix 3

The parameter or method name in the convention is a proper suffix.

Casing is used to delineate words in a given name. For instance, with this behavior the convention name "id" will match "id", or "personId" but not "grid" or "personid".

Applies to