Šablona adresy URL podrobností balíčku

Klient může vytvořit adresu URL, kterou může uživatel použít k zobrazení dalších podrobností balíčku ve webovém prohlížeči. To je užitečné, když zdroj balíčku chce zobrazit další informace o balíčku, který nemusí odpovídat rozsahu toho, co klientská aplikace NuGet zobrazuje.

Prostředek použitý k sestavení této adresy URL je prostředek, který PackageDetailsUriTemplate se nachází v indexu služby.

Vytváření verzí

Používají se následující @type hodnoty:

@type Hodnotu	Notes
PackageDetailsUriTemplate/5.1.0	Počáteční verze

Šablona adresy URL

Adresa URL pro následující rozhraní API je hodnota @id vlastnosti přidružené k jedné z výše uvedených hodnot prostředků @type .

Metody HTTP

I když klient není určen k odesílání požadavků na adresu URL podrobností balíčku jménem uživatele, webová stránka by měla podporovat metodu GET , aby bylo možné snadno otevřít kliknutou adresu URL ve webovém prohlížeči.

Vytvoření adresy URL

Vzhledem k známému ID a verzi balíčku může implementace klienta vytvořit adresu URL použitou pro přístup k webovému rozhraní. Implementace klienta by měla zobrazit tuto sestavenou adresu URL (nebo odkaz umožňující kliknutí) uživateli, který mu umožní otevřít webový prohlížeč na adresu URL a získat další informace o balíčku. Obsah stránky s podrobnostmi balíčku je určen implementací serveru.

Adresa URL musí být absolutní adresa URL a schéma (protokol) musí být HTTPS.

Hodnota @id indexu služby je řetězec adresy URL obsahující některý z následujících zástupných tokenů:

Zástupné symboly adres URL

Name	Type	Požaduje se	Notes
{id}	string	ne	ID balíčku pro získání podrobností
{version}	string	ne	Verze balíčku pro získání podrobností

Server by měl přijímat {id} hodnoty {version} s libovolným velikostí a velikostí. Kromě toho by server neměl být citlivý na to, jestli je verze normalizována. Jinými slovy, server by měl přijmout také nenormalizované verze.

Například šablona podrobností balíčku nuget.org vypadá takto:

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

Pokud implementace klienta potřebuje zobrazit odkaz na podrobnosti balíčku pro NuGet.Versioning 4.3.0, vytvoří následující adresu URL a poskytne ho uživateli:

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