ApiDescription Třída

Definice

Obor názvů:

Microsoft.AspNetCore.Mvc.ApiExplorer

Sestavení:

Microsoft.AspNetCore.Mvc.Abstractions.dll

Balíček:

Microsoft.AspNetCore.App.Ref v8.0.0

Zdroj:

ApiDescription.cs

Představuje rozhraní API vystavené touto aplikací.

public ref class ApiDescription

public class ApiDescription

type ApiDescription = class

Public Class ApiDescription

Dědičnost

Object

ApiDescription

Konstruktory

ApiDescription()

Představuje rozhraní API vystavené touto aplikací.

Vlastnosti

ActionDescriptor	Získá nebo nastaví ActionDescriptor pro toto rozhraní API.
GroupName	Získá nebo nastaví název skupiny pro toto rozhraní API.
HttpMethod	Získá nebo nastaví podporovanou metodu HTTP pro toto rozhraní API nebo null, pokud jsou podporovány všechny metody HTTP.
ParameterDescriptions	Získá seznam ApiParameterDescription pro toto rozhraní API.
Properties	Získá libovolné vlastnosti metadat přidružené k .ApiDescription
RelativePath	Získá nebo nastaví šablonu relativní cesty URL (vzhledem ke kořenovému adresáři aplikace) pro toto rozhraní API.
SupportedRequestFormats	Získá seznam možných formátů pro požadavek.
SupportedResponseTypes	Získá seznam možných formátů pro odpověď.

Metody rozšíření

GetProperty<T>(ApiDescription)	Získá hodnotu vlastnosti z Properties kolekce pomocí zadané hodnoty T jako klíč.
SetProperty<T>(ApiDescription, T)	Nastaví hodnotu vlastnosti v kolekci Properties pomocí zadané hodnoty T jako klíče.