ApiDescription Klasa

Definicja

Przestrzeń nazw:

Microsoft.AspNetCore.Mvc.ApiExplorer

Zestaw:

Microsoft.AspNetCore.Mvc.Abstractions.dll

Pakiet:

Microsoft.AspNetCore.App.Ref v9.0.0

Reprezentuje interfejs API uwidoczniony przez tę aplikację.

public ref class ApiDescription

public class ApiDescription

type ApiDescription = class

Public Class ApiDescription

Dziedziczenie

Object

ApiDescription

Konstruktory

ApiDescription()

Reprezentuje interfejs API uwidoczniony przez tę aplikację.

Właściwości

ActionDescriptor	Pobiera lub ustawia ActionDescriptor dla tego interfejsu API.
GroupName	Pobiera lub ustawia nazwę grupy dla tego interfejsu API.
HttpMethod	Pobiera lub ustawia obsługiwaną metodę HTTP dla tego interfejsu API lub wartość null, jeśli są obsługiwane wszystkie metody HTTP.
ParameterDescriptions	Pobiera listę dla tego interfejsu ApiParameterDescription API.
Properties	Pobiera dowolne właściwości metadanych skojarzone z elementem ApiDescription.
RelativePath	Pobiera lub ustawia szablon ścieżki względnej adresu URL (względem katalogu głównego aplikacji) dla tego interfejsu API.
SupportedRequestFormats	Pobiera listę możliwych formatów żądania.
SupportedResponseTypes	Pobiera listę możliwych formatów odpowiedzi.

Metody rozszerzania

GetProperty<T>(ApiDescription)	Pobiera wartość właściwości z Properties kolekcji przy użyciu podanej wartości T jako klucza.
SetProperty<T>(ApiDescription, T)	Ustawia wartość właściwości w kolekcji Properties przy użyciu podanej wartości T jako klucza.