Modelo de Uri README
É possível que um cliente crie uma URL que possa ser usada para baixar um README para um pacote específico. Isso permitirá que os clientes renderizem o README do pacote sem baixar todo o pacote.
O recurso usado para criar essa URL é o recurso de ReadmeUriTemplate encontrado no índice de serviço .
Controle de versão
Os seguintes valores de @type são usados:
| @type valor | Anotações |
|---|---|
| ReadmeUriTemplate/6.13.0 | A versão inicial |
Modelo de URL
A URL da API a seguir é o valor da propriedade @id associada a um dos valores de @type de recursos mencionados anteriormente.
Métodos HTTP
A URL construída deve dar suporte ao método HTTP GET
Construir a URL
Considerando uma ID de pacote conhecida e uma versão, a implementação do cliente pode construir uma URL para baixar o README.
O valor do @id é uma cadeia de caracteres de URL que contém qualquer um dos seguintes tokens de espaço reservado:
Espaços reservados de URL
| Nome | Tipo | Necessário | Anotações |
|---|---|---|---|
{lower_id} |
corda | Sim | A ID do pacote, em letras minúsculas |
{lower_version} |
corda | Sim | A versão do pacote, em letras minúsculas |
Tanto lower_id quanto lower_version são reduzidos usando as regras implementadas por . NET's método System.String.ToLowerInvariant().
O lower_version é a versão de pacote desejada normalizada usando a versão do NuGet regras de normalização. Isso significa que os metadados de build permitidos pela especificação SemVer 2.0.0 devem ser excluídos nesse caso.
Corpo da resposta
Se o pacote tiver um leiame, um código de status 200 será retornado. O corpo da resposta será o conteúdo de leitura em si.
Se o pacote não tiver um leiame, um código de status 404 será retornado.