ApiExplorerSettingsAttribute Class

  • Reference

Definition

Namespace:
System.Web.Http.Description
Assembly:
System.Web.Http.dll
Package:
Microsoft.AspNet.WebApi.Core v5.2.9

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

[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Field | System.AttributeTargets.Method | System.AttributeTargets.Property, AllowMultiple=false)]
public sealed class ApiExplorerSettingsAttribute : Attribute
[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Field | System.AttributeTargets.Method | System.AttributeTargets.Property, AllowMultiple=false)>]
type ApiExplorerSettingsAttribute = class
    inherit Attribute
Public NotInheritable Class ApiExplorerSettingsAttribute
Inherits Attribute
Inheritance
Attribute
ApiExplorerSettingsAttribute
Attributes
AttributeUsageAttribute

Constructors

ApiExplorerSettingsAttribute()

Initializes a new instance of the ApiExplorerSettingsAttribute class.

Properties

IgnoreApi

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

Applies to