Table of Contents

Class ApiExplorerSettingsAttribute

Namespace
System.Web.Http.Description
Assembly
System.Web.Http.dll

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

[AttributeUsage(AttributeTargets.Class|AttributeTargets.Method, AllowMultiple = false)]
public sealed class ApiExplorerSettingsAttribute : Attribute
Inheritance
ApiExplorerSettingsAttribute
Inherited Members

Constructors

ApiExplorerSettingsAttribute()

Initializes a new instance of the ApiExplorerSettingsAttribute class.

public ApiExplorerSettingsAttribute()

Properties

IgnoreApi

Gets or sets a value indicating whether to exclude the controller or action from the ApiDescription instances generated by ApiExplorer.

public bool IgnoreApi { get; set; }

Property Value

bool

true if the controller or action should be ignored; otherwise, false.