Mi az SDK? A szoftverfejlesztői készletek egyszerűen elmagyarázva

Az SDK (szoftverfejlesztői készlet) kész eszköztár, amelyet egy cég a fejlesztőinek ad, hogy a szolgáltatását vagy platformját ne kelljen nulláról felépíteniük. Általában tartalmaz egy kódkönyvtárat egy adott programozási nyelvhez, dokumentációt és példákat, néha pedig kiegészítő eszközöket, például tesztelőprogramokat. Amikor az appod „a Stripe SDK-t használja”, az azt jelenti, hogy a kódod a Stripe előre elkészített függvényeit hívja, ahelyett, hogy minden kérést kézzel írna meg a Stripe API-jához.

Miért fontosak az SDK-k, ha AI-val építesz

Amikor egy AI-építőtől fizetést, AI-csevegést, térképet vagy e-mailt kérsz, az általában telepíti az adott szolgáltató SDK-ját, és írt néhány sort, amely hívja. Ha tudod, mi az SDK, akkor:

• Érted, mi kerül a projektedbe. Az SDK függőség – külső kód, amelytől az appod most függ.
• Felismered a szükséges beállítást. Szinte minden SDK-hoz kell API-kulcs, és sokuknak van külön „szerveroldali” és „böngészős” változata, eltérő szabályokkal arra vonatkozóan, mely kulcsok használhatók biztonságosan.
• Pontosan fogalmazol. Az „használd a hivatalos Stripe SDK-t a szerveren” egyértelműbb utasítás, mint az „adj hozzá Stripe-ot”.
• Olvasod a hibákat. Az AI-val épített appok sok hibája abból ered, hogy egy SDK rosszul van beállítva, elavult, vagy rossz helyen használják.

Mindennapi hasonlat

Képzeld el, hogy polcot szeretnél felszerelni.

• Az API az épület szabályai: melyik falba mehet csavar, mekkora terhelést bír, hol futnak a csövek. Ezekből a szabályokból dolgozhatnál is, mindent magad mérve és fúrva.
• Az SDK egy kiszerelhető polckészlet ugyanattól a cégtől, amely a falakat gyártotta: előre vágott alkatrészek, a megfelelő csavarok, egy konzol, amely pontosan illik a falaikhoz, és egy útmutató.

Még mindig te döntöd el, hova kerül a polc és mi kerül rá. A készlet csak attól kímél meg, hogy fát vágj és csavarméretet találgass – és kisebb esély van arra, hogy vízvezetéket fúrsz át.

SDK vs API vs könyvtár vs keretrendszer

Ezek a fogalmak átfedik egymást, ami sokakat összezavar:

Az SDK általában tartalmaz egy könyvtárat, a könyvtár pedig általában hív egy API-t. Webszolgáltatásoknál az „SDK” és a „kliens könyvtár” kifejezést gyakran felcserélhetően használják.

Néhány SDK egyáltalán nem webszolgáltatásokról szól. Az Apple és a Google SDK-kat ad ki iOS- és Android-appok építéséhez, amelyek fordítókat, szimulátorokat és platformkódot tartalmaznak. Az elv ugyanaz: mindent, ami a platformjukra épített fejlesztéshez kell, egy készletben.

Mit tesz érted az SDK

Nézzük ugyanazt a feladatot – egy vásárló létrehozása egy fizetési szolgáltatónál – két módon.

SDK nélkül a kódodnak magának kell felépítenie a HTTP-kérést: beállítani az URL-t, a titkos kulcsot a megfelelő fejlécbe tenni, az adatokat olyan formába rendezni, amilyet az API vár, elküldeni, ellenőrizni a státuszkódot, feldolgozni a választ, és újrapróbálkozni, ha a hálózat megbotlik.

SDK-val ez közelebb van egy sorhoz:

const customer = await stripe.customers.create({ email: "lena@example.com" });

Ezen a sor mögött az SDK kezeli:

• Hitelesítés – a kulcsod helyes csatolása minden kéréshez
• Adatformázás – az adataid átalakítása azzá, amit az API vár, a választ pedig visszaalakítja objektumokká
• Hibák – a státuszkódok átalakítása egyértelmű hibatípusokká, amelyeket a kódod el tud kapni
• Újrapróbálkozás – biztonságos újrapróbálás, ha egy kérés átmeneti okból hibázik (sok hivatalos SDK ezt megteszi)
• Típusok – TypeScriptben megmondja a szerkesztődnek, mely mezők léteznek, így a hibák a kód futtatása előtt kiderülnek

Példa: AI-válaszok hozzáadása egy támogatási apphoz

Az AI-építőnek ezt kéred: „Amikor egy vásárló támogatási jegyet küld, generálj egy javasolt választ AI-modell segítségével.”

1. Az AI telepíti a modellszolgáltató hivatalos SDK-ját csomagként a projektedbe (JavaScript-projekteknél az npm-registryből).
2. Az API-kulcsot projekt-titokként adod hozzá. Az SDK ezt a szerveren egy környezeti változóból olvassa ki.
3. Az AI ír egy szerveroldali útvonalat, amely az SDK-val hívja a jegy szövegével és egy rövid utasítással, a javasolt választ pedig elmenti az adatbázisba.
4. A böngésző soha nem látja a kulcsot; csak a saját szerveroldali útvonaladdal kommunikál.

Ha a szolgáltató később megváltoztatja az API-ját, általában új SDK-verziót ad ki. Ilyenkor gyakran elég frissíteni a csomagot – és ellenőrizni a kiadási jegyzeteket a visszafelé nem kompatibilis változásokért.

Kulcsfogalmak

Gyakori tévhitek

• „Az SDK és az API ugyanaz.” Az API a szolgáltatás felülete; az SDK kényelmi réteg rajta. A legtöbb webes API-t SDK nélkül is hívhatod – csak több munka.
• „Ha az SDK telepítve van, az integráció kész.” Még kell egy fiók a szolgáltatónál, a megfelelő kulcsok, és olyan kód, amely kezeli, mi történik, ha valami hibázik.
• „Bármelyik csomag a megfelelő névvel a hivatalos.” A támadók néha hasonló nevű csomagokat tesznek közzé. Ellenőrizd a szolgáltató dokumentációjában a pontos csomagnevet.
• „A böngészős SDK használhatja a titkos kulcsomat.” Soha. A böngészős kódban minden látható a látogatók számára. A titkos kulcsok csak a szerveroldali kódba valók – lásd hogyan őrizd biztonságban az API-kulcsaidat.
• „Az SDK-t soha nem kell frissíteni.” A régi verziók nem kapnak javításokat, és végül nem működnek majd, amikor a szolgáltatók kivezetik a régi API-verziókat.

Mit kérdezz az AI-építőtől

• „A szolgáltató hivatalos SDK-ját használd, ne harmadik fél csomagolóját. Mondd meg a pontos csomagnevet és a telepített verziót.”
• „Az SDK-t csak a szerveren használd, és a kulcsot környezeti változóból olvasd ki.”
• „Az SDK mely részei futnak a böngészőben, és melyik kulcsokat használják?”
• „Mi történik, ha az SDK-hívás hibázik vagy időtúllépés lesz? Mutass a felhasználónak egyértelmű üzenetet, és naplózd a hibát.”
• „Sorold fel az összes SDK-t és csomagot, amelytől ez az app függ, és hogy mire való mindegyik.”
• „Ellenőrizd, hogy van-e elavult SDK-nk, vagy ismert biztonsági problémájú.”

SDK-k a Mythexben

A Mythex ügynöke a projekt sandboxában telepíthet csomagokat a munkafolyamatodhoz tartozó szokásos csomagkezelővel, beleértve a szolgáltatók SDK-it is – nevezd meg a csomagot és a funkciót, amelyhez kell. Lásd npm-csomagok használata. A Mythex nem ad kész integrációk katalógusát az appodhoz: a szolgáltató kulcsát projekt-titokként tárolod, és megkéred az ügynököt, hogy szerveroldalon hívja a szolgáltatást, ahogy az Integrate any API leírja.

Az SDK-k alatti rétegről olvasd el, mi az API. Két gyakori SDK-alapú funkcióhoz lásd hogyan adj fizetést az appodhoz és hogyan használj LLM API-kat.

Kérdések