Modelo de URL de detalhes do pacote

  • Artigo

É possível para um cliente criar uma URL que pode ser usada pelo usuário para ver mais detalhes do pacote em seu navegador da web. Isso é útil quando uma origem de pacote deseja mostrar informações adicionais sobre um pacote que pode não se encaixar no escopo do que o aplicativo cliente do NuGet mostra.

O recurso usado para criar essa URL é o recurso PackageDetailsUriTemplate encontrado no índice de serviço.

Controle de versão

Os seguintes valores de @type são usados:

@type valor Observações
PackageDetailsUriTemplate/5.1.0 O lançamento inicial

Modelo do URL

A URL da API a seguir é o valor da propriedade @id associada a um dos valores de recurso @type mencionados anteriormente.

Métodos HTTP

Embora o cliente não se destine a fazer solicitações para a URL de detalhes do pacote em nome do usuário, a página da Web deve oferecer suporte ao método GET para permitir que uma URL clicada seja facilmente aberta em um navegador da Web.

Criar a URL

Dada uma ID e versão de pacote conhecidas, a implementação do cliente pode criar uma URL usada para acessar uma interface da Web. A implementação do cliente deve exibir essa URL construída (ou link clicável) para o usuário, permitindo que ele abra um navegador da Web para a URL e saiba mais sobre o pacote. O conteúdo da página de detalhes do pacote é determinado pela implementação do servidor.

A URL deve ser uma URL absoluta e o esquema (protocolo) deve ser HTTPS.

O valor do @id no índice de serviço é uma cadeia de caracteres de URL que contém qualquer um dos seguintes tokens de espaço reservado:

Espaços reservados de URL

Nome Digitar Obrigatória Observações
{id} string não O ID do pacote para obter detalhes
{version} string não A versão do pacote para obter detalhes para

O servidor deve aceitar os valores de {id} e {version} em maiúsculas ou minúsculas. Além disso, o servidor não deve ser sensível se a versão é normalizada. Em outras palavras, o servidor deve aceitar também versões não normalizadas.

Por exemplo, o modelo de detalhes do pacote nuget.org tem esta aparência:

https://www.nuget.org/packages/{id}/{version}

Se a implementação do cliente precisar exibir um link para os detalhes do pacote para NuGet.Versioning 4.3.0, ela produzirá a seguinte URL e a fornecerá ao usuário:

https://www.nuget.org/packages/NuGet.Versioning/4.3.0