Modelo de URL de detalhes do proprietário

Os feeds de pacote que têm páginas de perfil de proprietário podem informar às ferramentas do cliente como construir a URL do perfil por meio desse modelo. Isso é útil quando uma fonte de pacote deseja habilitar todas as experiências do cliente (até mesmo de terceiros) para vincular à página de perfil de um proprietário de pacote específico.

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

Versioning

Os seguintes @type valores são usados:

@type valor Notes
OwnerDetailsUriTemplate/6.11.0 A versão inicial

Modelo de URL

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

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

https://www.nuget.org/profiles/{owner}

Métodos HTTP

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

Construir a URL

O recurso de pesquisa retorna informações de proprietário do pacote, incluindo nomes de usuário do proprietário. Considerando um nome de usuário proprietário do recurso de pesquisa, a implementação do cliente pode construir 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 proprietário. O conteúdo da página de detalhes do proprietário é determinado pela implementação do servidor.

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

O valor do @id índice de serviço é uma cadeia de caracteres de URL que contém o seguinte token de espaço reservado:

Espaços reservados de URL

Name Tipo Obrigatório Notes
{owner} cadeia Sim O nome de usuário do proprietário para obter detalhes

O cliente deve manter a maiúscula do nome de usuário em qualquer forma encontrada em outras respostas de API ou na assinatura do repositório de pacotes. NuGet.org trata nomes de usuário proprietários de maneira que não diferencia maiúsculas de minúsculas, mas nem todas as fontes de pacote podem ter essa flexibilidade.

Por exemplo, se a implementação do cliente precisar exibir um link para a página de detalhes do proprietário Microsoft, ela produzirá a seguinte URL e a fornecerá ao usuário:

https://www.nuget.org/profiles/Microsoft