Dela via

ApiExplorerSettingsAttribute Class

Definition

Namespace:
Microsoft.AspNetCore.Mvc
Assembly:
Microsoft.AspNetCore.Mvc.Core.dll
Package:
Microsoft.AspNetCore.Mvc.Core v1.0.0
Package:
Microsoft.AspNetCore.Mvc.Core v1.1.0
Package:
Microsoft.AspNetCore.App.Ref v10.0.0-preview.7.25380.108
Package:
Microsoft.AspNetCore.Mvc.Core v2.0.0
Package:
Microsoft.AspNetCore.Mvc.Core v2.1.0
Package:
Microsoft.AspNetCore.Mvc.Core v2.2.0
Package:
Microsoft.AspNetCore.App.Ref v3.0.1
Package:
Microsoft.AspNetCore.App.Ref v3.1.10
Package:
Microsoft.AspNetCore.App.Ref v5.0.0
Package:
Microsoft.AspNetCore.App.Ref v6.0.6
Package:
Microsoft.AspNetCore.App.Ref v7.0.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.19
Package:
Microsoft.AspNetCore.App.Ref v9.0.8
Source:
ApiExplorerSettingsAttribute.cs
Source:
ApiExplorerSettingsAttribute.cs
Source:
ApiExplorerSettingsAttribute.cs

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
Attribute
ApiExplorerSettingsAttribute
Attributes
AttributeUsageAttribute
Implements
IApiDescriptionGroupNameProvider IApiDescriptionVisibilityProvider

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