nuget.org protokollok

A nuget.org használatához az ügyfeleknek bizonyos protokollokat kell követnie. Mivel ezek a protokollok folyamatosan fejlődnek, az ügyfeleknek azonosítaniuk kell az adott nuget.org API-k meghívásakor használt protokollverziót. Ez lehetővé teszi nuget.org számára, hogy a régi ügyfelek számára kompatibilis módon vezessenek be módosításokat.

Megjegyzés:

Az ezen a lapon dokumentált API-k nuget.org vonatkoznak, és nem várható, hogy más NuGet-kiszolgálói implementációk is bevezetik ezeket az API-kat.

A NuGet-ökoszisztémában széles körben implementált NuGet API-val kapcsolatos információkért tekintse meg az API áttekintését.

Ez a témakör a különböző protokollokat sorolja fel, mint és amikor azok létrejönnek.

A NuGet protokoll 4.1.0-s verziója

A 4.1.0 protokoll az ellenőrzési hatókörű kulcsok használatát határozza meg a nuget.org kívüli szolgáltatásokkal való interakcióhoz, a csomag nuget.org-fiókon való érvényesítéséhez. Vegye figyelembe, hogy a 4.1.0 verziószám egy átlátszatlan sztring, de történetesen egybeesik a protokollt támogató hivatalos NuGet-ügyfél első verziójával.

Az ellenőrzés biztosítja, hogy a felhasználó által létrehozott API-kulcsok csak a nuget.org-on legyenek használva, és hogy a külső szolgáltatáson keresztüli bármilyen egyéb ellenőrzés vagy validáció egy egyszer használatos ellenőrző hatókör-kulcson keresztül legyen kezelve. Ezek az ellenőrzési hatókörkulcsok segítségével ellenőrizheti, hogy a csomag egy adott felhasználóhoz (fiókhoz) tartozik-e a nuget.org.

Ügyfélkövetelmény

Az ügyfeleknek a következő fejlécet kell átadniuk, amikor API-hívásokat kezdeményeznek a csomagok nuget.org való leküldéséhez :

X-NuGet-Protocol-Version: 4.1.0

Vegye figyelembe, hogy a X-NuGet-Client-Version fejléc hasonló szemantikával rendelkezik, de csak a hivatalos NuGet-ügyfél használhatja. A külső ügyfeleknek a fejlécet és az X-NuGet-Protocol-Version értéket kell használniuk.

Magát a leküldéses protokollt az erőforrás dokumentációja PackagePublishismerteti.

Ha egy ügyfél külső szolgáltatásokkal kommunikál, és ellenőriznie kell, hogy egy csomag egy adott felhasználóhoz (fiókhoz) tartozik-e, az alábbi protokollt kell használnia, és nem a nuget.org API-kulcsait kell használnia.

API ellenőrző hatókörű kulcs lekéréséhez

Ez az API egy ellenőrző hatókörkulcs lekérésére szolgál egy nuget.org szerző számára, amely ellenőrzi az általa birtokolt csomagot.

POST api/v2/package/create-verification-key/{ID}/{VERSION}

Kérelemparaméterek

Név	In	Típus	Kötelező	Jegyzetek
azonosító	URL	karakterlánc	yes	Az a csomagazonosító, amelyhez az ellenőrző hatókörkulcsot kérik
VERSION	URL	karakterlánc	no	A csomag verziója
X-NuGet-ApiKey	Header	karakterlánc	yes	Például: X-NuGet-ApiKey: {USER_API_KEY}

Válasz

{
    "Key": "{Verify scope key from nuget.org}",
    "Expires": "{Date}"
}

API az ellenőrzési hatókör kulcsának ellenőrzéséhez

Ez az API a nuget.org szerzője által birtokolt csomag ellenőrzési hatókörkulcsának ellenőrzésére szolgál.

GET api/v2/verifykey/{ID}/{VERSION}

Kérelemparaméterek

Név	In	Típus	Kötelező	Jegyzetek
azonosító	URL	karakterlánc	yes	Az a csomagazonosító, amelyhez az ellenőrző hatókörkulcsot kérik
VERSION	URL	karakterlánc	no	A csomag verziója
X-NuGet-ApiKey	Header	karakterlánc	yes	Például: X-NuGet-ApiKey: {VERIFY_SCOPE_KEY}

Megjegyzés:

Ez az ellenőrző hatókör API-kulcs egy nap múlva vagy az első használatkor lejár, attól függően, hogy amelyik előbb bekövetkezik.

Válasz

Állapotkód	Meaning
200	Az API-kulcs érvényes
403 hibakód	Az API-kulcs érvénytelen vagy nincs jogosultsága a csomagra való feltöltésre.
404	A hivatkozott ID és VERSION (nem kötelező) csomag nem létezik