ApiConventionApplicationModelConvention Class

Reference

Definition

Namespace:: Microsoft.AspNetCore.Mvc.ApplicationModels

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

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

An IActionModelConvention that discovers

ApiConventionResult from applied ApiConventionTypeAttribute or ApiConventionMethodAttribute.
ProducesErrorResponseTypeAttribute that applies to the action.

public ref class ApiConventionApplicationModelConvention : Microsoft::AspNetCore::Mvc::ApplicationModels::IActionModelConvention

public class ApiConventionApplicationModelConvention : Microsoft.AspNetCore.Mvc.ApplicationModels.IActionModelConvention

type ApiConventionApplicationModelConvention = class
    interface IActionModelConvention

Public Class ApiConventionApplicationModelConvention
Implements IActionModelConvention

Inheritance: Object
ApiConventionApplicationModelConvention

Implements: IActionModelConvention

Constructors

ApiConventionApplicationModelConvention(ProducesErrorResponseTypeAttribute)

Initializes a new instance of ApiConventionApplicationModelConvention.

Properties

DefaultErrorResponseType

Gets the default ProducesErrorResponseTypeAttribute that is associated with an action when no attribute is discovered.

Methods

Apply(ActionModel)	Called to apply the convention to the ActionModel.
ShouldApply(ActionModel)	Determines if this instance of IActionModelConvention applies to a specified `action`.

Applies to