ApiExplorerSettingsAttribute Class

Controls the visibility and group name for an <code>ApiDescription</code> of the associated controller class or action method.

Namespace
Microsoft.AspNetCore.Mvc
Assemblies
  • Microsoft.AspNetCore.Mvc.Core

Syntax

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = false, Inherited = true)]
public class ApiExplorerSettingsAttribute : Attribute, _Attribute, IApiDescriptionGroupNameProvider, IApiDescriptionVisibilityProvider
class Microsoft.AspNetCore.Mvc.ApiExplorerSettingsAttribute

Properties

Microsoft.AspNetCore.Mvc.ApiExplorerSettingsAttribute.GroupName
Return type:System.String 
public string GroupName { get; set; }
Microsoft.AspNetCore.Mvc.ApiExplorerSettingsAttribute.IgnoreApi
Return type:System.Boolean 
public bool IgnoreApi { get; set; }