ApiExplorerSettingsAttribute Klasse

Definition

Namespace:

Microsoft.AspNetCore.Mvc

Assembly:

Microsoft.AspNetCore.Mvc.Core.dll

Paket:

Microsoft.AspNetCore.App.Ref v8.0.0

Quelle:

ApiExplorerSettingsAttribute.cs

Steuert die Sichtbarkeit und den Gruppennamen für eine ApiDescription der zugeordneten Controllerklasse oder Aktionsmethode.

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

Vererbung

Attribute

ApiExplorerSettingsAttribute

Attribute

AttributeUsageAttribute

Implementiert

IApiDescriptionGroupNameProvider IApiDescriptionVisibilityProvider

Konstruktoren

ApiExplorerSettingsAttribute()

Steuert die Sichtbarkeit und den Gruppennamen für eine ApiDescription der zugeordneten Controllerklasse oder Aktionsmethode.

Eigenschaften

GroupName	Der Gruppenname für die ApiDescription der zugeordneten Aktion oder des zugehörigen Controllers.
IgnoreApi	Wenn true dann werden keine ApiDescription Objekte für den zugeordneten Controller oder die zugehörige Aktion erstellt.