Share via

Modèle d’URL de détails du package

  • Article

Il est possible qu’un client crée une URL qui peut être utilisée par l’utilisateur pour afficher plus de détails sur le package dans son navigateur web. Cela est utile lorsqu’une source de package souhaite afficher des informations supplémentaires sur un package qui peut ne pas correspondre à l’étendue de ce que l’application cliente NuGet affiche.

La ressource utilisée pour générer cette URL est la ressource PackageDetailsUriTemplate trouvée dans l’index de service.

Contrôle de version

Les valeurs @type suivantes sont utilisées :

Valeur @type Notes
PackageDetailsUriTemplate/5.1.0 La version initiale

URL template

L’URL de l’API suivante est la valeur de la propriété @id associée à l’une des valeurs de ressource @type mentionnées ci-dessus.

Méthodes HTTP

Bien que le client n’ait pas l’intention d’envoyer des demandes à l’URL des détails du package pour le compte de l’utilisateur, la page web doit prendre en charge la méthode GET pour autoriser l’ouverture facile d’une URL cliquée dans un navigateur web.

Construire l’URL

Étant donné un ID de package et une version connus, l’implémentation du client peut construire une URL utilisée pour accéder à une interface web. L’implémentation du client doit afficher cette URL construite (ou lien cliquable) à l’utilisateur, ce qui lui permet d’ouvrir un navigateur web à l’URL et d’en savoir plus sur le package. Le contenu de la page de détails du package est déterminé par l’implémentation du serveur.

L’URL doit être une URL absolue et le schéma (protocole) doit être HTTPS.

La valeur de l’index @id de service est une chaîne d’URL contenant l’un des jetons d’espace réservé suivants :

Espaces réservés d’URL.

Nom Type Requise Notes
{id} string non ID de package pour obtenir des détails
{version} string non Version du package pour obtenir des détails pour

Le serveur doit accepter les valeurs {id} et {version} avec n’importe quelle casse. De plus, le serveur ne doit pas être sensible à la normalisation de la version. En d’autres termes, le serveur doit accepter également les versions non normalisées.

Par exemple, le modèle de détails du package nuget.org ressemble à ceci :

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

Si l’implémentation du client doit afficher un lien vers les détails du package pour NuGet.Versioning 4.3.0, elle produit l’URL suivante et la fournit à l’utilisateur :

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