Modèle d’URI README
Il est possible qu’un client crée une URL qui peut être utilisée pour télécharger un fichier README pour un package spécifique. Cela permet aux clients d’afficher le fichier README du package sans télécharger l’intégralité du package.
La ressource utilisée pour générer cette URL est la ressource ReadmeUriTemplate trouvée dans l’index de service .
Contrôle de version
Les valeurs @type suivantes sont utilisées :
| valeur @type | Notes |
|---|---|
| ReadmeUriTemplate/6.13.0 | La version initiale |
Modèle d’URL
L’URL de l’API suivante est la valeur de la propriété @id associée à l’une des valeurs @type de ressources mentionnées ci-dessus.
Méthodes HTTP
L’URL construite doit prendre en charge la méthode HTTP GET
Construire l’URL
Compte tenu d’un ID de package et d’une version connus, l’implémentation du client peut construire une URL pour télécharger le fichier README.
La valeur du @id est une chaîne d’URL contenant l’un des jetons d’espace réservé suivants :
Espaces réservés d’URL
| Nom | Type | Obligatoire | Notes |
|---|---|---|---|
{lower_id} |
corde | oui | ID du package, en minuscules |
{lower_version} |
corde | oui | Version du package, en minuscules |
Les deux lower_id et lower_version sont en minuscules à l’aide des règles implémentées par . NET méthode System.String.ToLowerInvariant().
Le lower_version est la version de package souhaitée normalisée à l’aide des règles de normalisation de version de NuGet. Cela signifie que les métadonnées de build autorisées par la spécification SemVer 2.0.0 doivent être exclues dans ce cas.
Corps de la réponse
Si le package a un fichier lisez-moi, un code d’état 200 est retourné. Le corps de la réponse sera le contenu readme lui-même.
Si le package n’a pas de fichier lisez-moi, un code d’état 404 est retourné.