ApiDescription Classe

Definição

Namespace:

Microsoft.AspNetCore.Mvc.ApiExplorer

Assembly:

Microsoft.AspNetCore.Mvc.Abstractions.dll

Pacote:

Microsoft.AspNetCore.App.Ref v9.0.0

Representa uma API exposta por este aplicativo.

public ref class ApiDescription

public class ApiDescription

type ApiDescription = class

Public Class ApiDescription

Herança

Object

ApiDescription

Construtores

ApiDescription()

Representa uma API exposta por este aplicativo.

Propriedades

ActionDescriptor	Obtém ou define ActionDescriptor para esta API.
GroupName	Obtém ou define o nome do grupo para esta API.
HttpMethod	Obtém ou define o método HTTP com suporte para essa api ou nulo se todos os métodos HTTP tiverem suporte.
ParameterDescriptions	Obtém uma lista de ApiParameterDescription para esta API.
Properties	Obtém propriedades de metadados arbitrárias associadas ao ApiDescription.
RelativePath	Obtém ou define o modelo de caminho de URL relativo (relativo à raiz do aplicativo) para essa API.
SupportedRequestFormats	Obtém a lista de formatos possíveis para uma solicitação.
SupportedResponseTypes	Obtém a lista de formatos possíveis para uma resposta.

Métodos de Extensão

GetProperty<T>(ApiDescription)	Obtém o valor de uma propriedade da Properties coleção usando o valor fornecido de T como a chave.
SetProperty<T>(ApiDescription, T)	Define o valor de uma propriedade na Properties coleção usando o valor fornecido de T como a chave.