README Uri-sablon
Az ügyfél létrehozhat egy URL-címet, amely egy adott csomag README-jének letöltéséhez használható. Ez lehetővé teszi, hogy az ügyfelek a teljes csomag letöltése nélkül rendereljék a csomag README-jét.
Az URL-cím létrehozásához használt erőforrás a szolgáltatásindexbentalálható ReadmeUriTemplate erőforrás.
Verziószámozás
A rendszer a következő @type értékeket használja:
| @type érték | Notes |
|---|---|
| ReadmeUriTemplate/6.13.0 | A kezdeti kiadás |
URL-sablon
A következő API URL-címe a fent említett erőforrás @type értékek egyikéhez társított @id tulajdonság értéke.
HTTP-metódusok
A létrehozott URL-címnek támogatnia kell a HTTP-metódust GET
Az URL-cím létrehozása
Az ismert csomagazonosító és -verzió alapján az ügyfél implementációja létrehozhat egy URL-címet a README letöltéséhez.
A @id értéke egy URL-sztring, amely a következő helyőrző jogkivonatok bármelyikét tartalmazza:
URL-helyőrzők
| Név | Típus | Szükséges | Notes |
|---|---|---|---|
{lower_id} |
húr | igen | A csomagazonosító, kisbetűs |
{lower_version} |
húr | igen | A csomag verziója, kisbetűs |
A lower_id és a lower_version is kisbetűsek a által implementált szabályokkal. NET-ek
System.String.ToLowerInvariant() metódus.
A lower_version a kívánt csomagverzió, amely a NuGet normalizálási szabályainakhasználatával normalizálva. Ez azt jelenti, hogy a SemVer 2.0.0 specifikáció által engedélyezett metaadatokat ebben az esetben ki kell zárni.
Válasz törzse
Ha a csomag rendelkezik olvasási kóddal, a rendszer 200 állapotkódot ad vissza. A válasz törzse maga az olvasási tartalom lesz.
Ha a csomag nem rendelkezik olvasási kóddal, a rendszer egy 404-ben megadott állapotkódot ad vissza.