URL-sjabloon voor eigenaardetails

Pakketfeeds met eigenaarsprofielpagina's kunnen clienthulpprogramma's informeren over het maken van de profiel-URL via deze sjabloon. Dit is handig wanneer een pakketbron alle clientervaringen (zelfs van derden) wil koppelen aan de profielpagina van een specifieke pakketeigenaar.

De resource die wordt gebruikt voor het bouwen van deze URL, is de OwnerDetailsUriTemplate resource die in de serviceindex wordt gevonden.

Versioning

De volgende @type waarden worden gebruikt:

@type Waarde Notes
OwnerDetailsUriTemplate/6.11.0 De eerste release

URL-sjabloon

De URL voor de volgende API is de waarde van de @id eigenschap die is gekoppeld aan een van de bovengenoemde resourcewaarden @type .

De sjabloon voor eigenaargegevens van nuget.org ziet er bijvoorbeeld als volgt uit:

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

HTTP-methoden

Hoewel de client niet bedoeld is om namens de gebruiker aanvragen te doen naar de URL van de eigenaargegevens, moet de webpagina de GET methode ondersteunen om een op een klik-URL eenvoudig te kunnen openen in een webbrowser.

De URL maken

De zoekresource retourneert informatie over pakketeigenaars, inclusief gebruikersnamen van eigenaars. Gezien de gebruikersnaam van een eigenaar uit de zoekresource, kan de client-implementatie een URL maken die wordt gebruikt voor toegang tot een webinterface. De client-implementatie moet deze samengestelde URL (of klikbare koppeling) weergeven aan de gebruiker, zodat ze een webbrowser kunnen openen naar de URL en voor meer informatie over de eigenaar. De inhoud van de pagina met details van de eigenaar wordt bepaald door de server-implementatie.

De URL moet een absolute URL zijn en het schema (protocol) moet HTTPS zijn.

De waarde van de @id serviceindex is een URL-tekenreeks met het volgende tijdelijke aanduidingstoken:

Tijdelijke aanduidingen voor URL's

Name Type Verplicht Notes
{owner} touw yes De gebruikersnaam van de eigenaar voor het ophalen van details voor

De client moet de behuizing van de gebruikersnaam behouden in welke vorm deze ook is gevonden in andere API-antwoorden of in de handtekening van de pakketopslagplaats. NuGet.org behandelt gebruikersnamen van eigenaars op een niet-hoofdlettergevoelige manier, maar niet alle pakketbronnen hebben deze flexibiliteit.

Als de client-implementatie bijvoorbeeld een koppeling naar de pagina met eigenaargegevens voor de eigenaar Microsoftmoet weergeven, wordt de volgende URL geproduceerd en aan de gebruiker verstrekt:

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