ApiDescription Класс

Определение

Пространство имен:

Microsoft.AspNetCore.Mvc.ApiExplorer

Сборка:

Microsoft.AspNetCore.Mvc.Abstractions.dll

Пакет:

Microsoft.AspNetCore.App.Ref v8.0.0

Представляет API, предоставляемый этим приложением.

public ref class ApiDescription

public class ApiDescription

type ApiDescription = class

Public Class ApiDescription

Наследование

Object

ApiDescription

Конструкторы

ApiDescription()

Представляет API, предоставляемый этим приложением.

Свойства

ActionDescriptor	Возвращает или задает ActionDescriptor для этого API.
GroupName	Возвращает или задает имя группы для этого API.
HttpMethod	Возвращает или задает поддерживаемый метод HTTP для этого API или значение NULL, если поддерживаются все методы HTTP.
ParameterDescriptions	Возвращает список ApiParameterDescription для этого API.
Properties	Возвращает произвольные свойства метаданных, связанные с ApiDescription.
RelativePath	Возвращает или задает шаблон относительного URL-пути (относительно корневого каталога приложения) для этого API.
SupportedRequestFormats	Возвращает список возможных форматов для запроса.
SupportedResponseTypes	Возвращает список возможных форматов ответа.

Методы расширения

GetProperty<T>(ApiDescription)	Возвращает значение свойства из коллекции, Properties используя предоставленное значение в T качестве ключа.
SetProperty<T>(ApiDescription, T)	Задает значение свойства в коллекции, Properties используя предоставленное значение T в качестве ключа.