README Uri-mall
Det är möjligt för en klient att skapa en URL som kan användas för att ladda ned en README för ett visst paket. Detta gör det möjligt för klienterna att återge paketets README utan att ladda ned hela paketet.
Resursen som används för att skapa den här URL:en är den ReadmeUriTemplate resurs som finns i -tjänstindexet.
Versionshantering
Följande @type värden används:
| @type värde | Anteckningar |
|---|---|
| ReadmeUriTemplate/6.13.0 | Den första versionen |
URL-mall
URL:en för följande API är värdet för egenskapen @id som är associerad med något av ovan nämnda resursvärden @type.
HTTP-metoder
Den konstruerade URL:en måste ha stöd för HTTP-metoden GET
Skapa URL:en
Med ett känt paket-ID och en version kan klientimplementeringen konstruera en URL för att ladda ned README.
Värdet för @id är en URL-sträng som innehåller någon av följande platshållartoken:
URL-platshållare
| Namn | Typ | Krävs | Anteckningar |
|---|---|---|---|
{lower_id} |
sträng | Ja | Paket-ID:t, nedsänket |
{lower_version} |
sträng | Ja | Paketversionen, nedsänkad |
Både lower_id och lower_version sänks med hjälp av de regler som implementeras av . NET:s
System.String.ToLowerInvariant() metod.
lower_version är den önskade paketversionen som normaliserats med NuGets version normaliseringsregler. Det innebär att byggmetadata som tillåts av SemVer 2.0.0-specifikationen måste undantas i det här fallet.
Svarstext
Om paketet har en readme returneras en 200-statuskod. Svarstexten är själva readme-innehållet.
Om paketet inte har en readme returneras en 404-statuskod.