Share via


ApiExplorerSettingsAttribute Class

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

Inheritance Hierarchy

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

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

Syntax

'Declaration
<AttributeUsageAttribute(AttributeTargets.Class Or AttributeTargets.Method, AllowMultiple := False)> _
Public NotInheritable Class ApiExplorerSettingsAttribute _
    Inherits Attribute
'Usage
Dim instance As ApiExplorerSettingsAttribute
[AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Method, AllowMultiple = false)]
public sealed class ApiExplorerSettingsAttribute : Attribute
[AttributeUsageAttribute(AttributeTargets::Class|AttributeTargets::Method, AllowMultiple = false)]
public ref class ApiExplorerSettingsAttribute sealed : public Attribute
[<SealedAttribute>]
[<AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Method, AllowMultiple = false)>]
type ApiExplorerSettingsAttribute =  
    class 
        inherit Attribute 
    end
public final class ApiExplorerSettingsAttribute extends Attribute

The ApiExplorerSettingsAttribute type exposes the following members.

Constructors

  Name Description
Public method ApiExplorerSettingsAttribute Initializes a new instance of the ApiExplorerSettingsAttribute class.

Top

Properties

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

Top

Methods

  Name Description
Public method Equals (Inherited from Attribute.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Attribute.)
Public method GetType (Inherited from Object.)
Public method IsDefaultAttribute (Inherited from Attribute.)
Public method Match (Inherited from Attribute.)
Protected method MemberwiseClone (Inherited from Object.)
Public method ToString (Inherited from Object.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method _Attribute.GetIDsOfNames (Inherited from Attribute.)
Explicit interface implemetationPrivate method _Attribute.GetTypeInfo (Inherited from Attribute.)
Explicit interface implemetationPrivate method _Attribute.GetTypeInfoCount (Inherited from Attribute.)
Explicit interface implemetationPrivate method _Attribute.Invoke (Inherited from Attribute.)

Top

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.

See Also

Reference

System.Web.Http.Description Namespace