ApiExplorerSettingsAttribute Class

Article
10/28/2015

This attribute can be used on the controllers and actions to influence the behavior of ApiExplorer.

Namespace: System.Web.Http.Description
Assembly: System.Web.Http (in System.Web.Http.dll)

Inheritance Hierarchy

System.Object
System.Attribute
System.Web.Http.Description.ApiExplorerSettingsAttribute

Syntax

[AttributeUsageAttribute(AttributeTargets.Class | AttributeTargets.Method | AttributeTargets.Property | AttributeTargets.Field, 
    AllowMultiple = false)]
public sealed class ApiExplorerSettingsAttribute : Attribute

[AttributeUsageAttribute(AttributeTargets::Class | AttributeTargets::Method | AttributeTargets::Property | AttributeTargets::Field, 
    AllowMultiple = false)]
public ref class ApiExplorerSettingsAttribute sealed : Attribute

[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Class | AttributeTargets.Method | AttributeTargets.Property | AttributeTargets.Field,
    AllowMultiple = false)>]
type ApiExplorerSettingsAttribute = 
    class
        inherit Attribute
    end

<AttributeUsageAttribute(AttributeTargets.Class Or AttributeTargets.Method Or AttributeTargets.Property Or AttributeTargets.Field,
    AllowMultiple := False)>
Public NotInheritable Class ApiExplorerSettingsAttribute
    Inherits Attribute

Constructors

	Name	Description
	ApiExplorerSettingsAttribute()	Initializes a new instance of the ApiExplorerSettingsAttribute class.

Properties

	Name	Description
	IgnoreApi	Gets or sets a value indicating whether to exclude the controller or action from the ApiDescription instances generated by ApiExplorer.
	TypeId	(Inherited from Attribute.)

Methods

	Name	Description
	Equals(Object)	(Inherited from Attribute.)
	GetHashCode()	(Inherited from Attribute.)
	GetType()	(Inherited from Object.)
	IsDefaultAttribute()	(Inherited from Attribute.)
	Match(Object)	(Inherited from Attribute.)
	ToString()	(Inherited from Object.)

Explicit Interface Implementations

	Name	Description
	_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	(Inherited from Attribute.)
	_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	(Inherited from Attribute.)
	_Attribute.GetTypeInfoCount(UInt32)	(Inherited from Attribute.)
	_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	(Inherited from Attribute.)

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.