ApiDescription Classe

Définition

Espace de noms:

Microsoft.AspNetCore.Mvc.ApiExplorer

Assembly:

Microsoft.AspNetCore.Mvc.Abstractions.dll

Paquet:

Microsoft.AspNetCore.App.Ref v8.0.0

Représente une API exposée par cette application.

public ref class ApiDescription

public class ApiDescription

type ApiDescription = class

Public Class ApiDescription

Héritage

Object

ApiDescription

Constructeurs

ApiDescription()

Représente une API exposée par cette application.

Propriétés

ActionDescriptor	Obtient ou définit ActionDescriptor pour cette API.
GroupName	Obtient ou définit le nom du groupe pour cette API.
HttpMethod	Obtient ou définit la méthode HTTP prise en charge pour cette API, ou null si toutes les méthodes HTTP sont prises en charge.
ParameterDescriptions	Obtient la liste de ApiParameterDescription pour cette API.
Properties	Obtient les propriétés de métadonnées arbitraires associées à .ApiDescription
RelativePath	Obtient ou définit le modèle de chemin d’url relatif (par rapport à la racine de l’application) pour cette API.
SupportedRequestFormats	Obtient la liste des formats possibles pour une requête.
SupportedResponseTypes	Obtient la liste des formats possibles pour une réponse.

Méthodes d’extension

GetProperty<T>(ApiDescription)	Obtient la valeur d’une propriété de la Properties collection en utilisant la valeur fournie de T comme clé.
SetProperty<T>(ApiDescription, T)	Définit la valeur d’une propriété dans la collection à l’aide Properties de la valeur fournie de T comme clé.