ApiExplorerSettingsAttribute Class

Definition

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

public ref class ApiExplorerSettingsAttribute : Attribute, Microsoft::AspNetCore::Mvc::ApiExplorer::IApiDescriptionGroupNameProvider, Microsoft::AspNetCore::Mvc::ApiExplorer::IApiDescriptionVisibilityProvider
[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Method, AllowMultiple=false, Inherited=true)]
public class ApiExplorerSettingsAttribute : Attribute, Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionGroupNameProvider, Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionVisibilityProvider
[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Method, AllowMultiple=false, Inherited=true)>]
type ApiExplorerSettingsAttribute = class
    inherit Attribute
    interface IApiDescriptionGroupNameProvider
    interface IApiDescriptionVisibilityProvider
Public Class ApiExplorerSettingsAttribute
Inherits Attribute
Implements IApiDescriptionGroupNameProvider, IApiDescriptionVisibilityProvider
Inheritance
ApiExplorerSettingsAttribute
Attributes
Implements

Constructors

ApiExplorerSettingsAttribute()

Properties

GroupName

The group name for the ApiDescription of the associated action or controller.

IgnoreApi

If true then no ApiDescription objects will be created for the associated controller or action.

Applies to