Modèle d’URL des détails du propriétaire

Les flux de package qui ont des pages de profil propriétaire peuvent informer les outils clients de la façon de construire l’URL du profil via ce modèle. Cela est utile lorsqu’une source de package souhaite permettre à toutes les expériences client (même tierces) de créer un lien vers la page de profil d’un propriétaire de package spécifique.

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

Versioning

Les valeurs suivantes @type sont utilisées :

@type valeur Notes
OwnerDetailsUriTemplate/6.11.0 La version initiale

Modèle d’URL

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

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

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

Méthodes HTTP

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

Construire l’URL

La ressource de recherche retourne les informations du propriétaire du package, y compris les noms d’utilisateur du propriétaire. Étant donné un nom d’utilisateur propriétaire à partir de la ressource de recherche, 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 lui permettant d’ouvrir un navigateur web à l’URL et d’en savoir plus sur le propriétaire. Le contenu de la page de détails du propriétaire 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 le jeton d’espace réservé suivant :

Espaces réservés d’URL

Name Type Obligatoire Notes
{owner} string yes Nom d’utilisateur du propriétaire pour obtenir des détails

Le client doit conserver la casse du nom d’utilisateur sous la forme qu’il a trouvée dans d’autres réponses d’API ou dans la signature du dépôt de package. NuGet.org traite les noms d’utilisateur du propriétaire de manière insensible à la casse, mais toutes les sources de package peuvent avoir cette flexibilité.

Par exemple, si l’implémentation du client doit afficher un lien vers la page de détails du propriétaire pour le propriétaire Microsoft, elle produit l’URL suivante et la fournit à l’utilisateur :

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