Šablona identifikátoru URI README

Klient může vytvořit adresu URL, která se dá použít ke stažení souboru README pro konkrétní balíček. Klienti tak budou moct vykreslit soubor README balíčku bez stažení celého balíčku.

Prostředek použitý k sestavení této adresy URL je prostředek ReadmeUriTemplate nalezený v indexu služby.

Správa verzí

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

hodnota @type	Poznámky
ReadmeUriTemplate/6.13.0	Počáteční verze

Šablona adresy URL

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

Metody HTTP

Konstruovaná adresa URL musí podporovat metodu HTTP GET

Vytvoření adresy URL

Vzhledem ke známému ID a verzi balíčku může implementace klienta vytvořit adresu URL pro stažení souboru README.

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

Zástupné symboly adres URL

Jméno	Typ	Požadovaný	Poznámky
{lower_id}	řetězec	Ano	ID balíčku, s nižšími písmeny
{lower_version}	řetězec	Ano	Verze balíčku, která je nižší než malá.

lower_id i lower_version se snižují pomocí pravidel implementovaných . NET System.String.ToLowerInvariant() metoda.

lower_version je požadovaná verze balíčku normalizována pomocí pravidel normalizace verze NuGet pravidel normalizace. To znamená, že metadata sestavení povolená specifikací SemVer 2.0.0 musí být v tomto případě vyloučena.

Text odpovědi

Pokud má balíček soubor readme, vrátí se stavový kód 200. Text odpovědi bude samotný obsah souboru readme.

Pokud balíček nemá readme, vrátí se stavový kód 404.