ApiDescription Classe

Referência

Definição

Namespace:: Microsoft.AspNetCore.Mvc.ApiExplorer

Assembly:: Microsoft.AspNetCore.Mvc.ApiExplorer.dll

Assembly:: Microsoft.AspNetCore.Mvc.Abstractions.dll

Pacote:: Microsoft.AspNetCore.Mvc.ApiExplorer v1.0.0

Pacote:: Microsoft.AspNetCore.Mvc.ApiExplorer v1.1.0

Pacote:: Microsoft.AspNetCore.Mvc.Abstractions v2.0.0

Pacote:: Microsoft.AspNetCore.Mvc.Abstractions v2.1.0

Pacote:: Microsoft.AspNetCore.Mvc.Abstractions v2.2.0

Pacote:: Microsoft.AspNetCore.App.Ref v3.0.1

Pacote:: Microsoft.AspNetCore.App.Ref v3.1.10

Pacote:: Microsoft.AspNetCore.App.Ref v5.0.0

Pacote:: Microsoft.AspNetCore.App.Ref v6.0.6

Pacote:: Microsoft.AspNetCore.App.Ref v7.0.5

Pacote:: Microsoft.AspNetCore.App.Ref v8.0.0

Pacote:: Microsoft.AspNetCore.App.Ref v9.0.0

Origem:: ApiDescription.cs

Origem:: ApiDescription.cs

Origem:: ApiDescription.cs

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

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.

Aplica-se a

Compartilhar via