Kaj je SDK? Razvojni kompleti (SDK) preprosto pojasnjeni

SDK (software development kit, razvojni komplet) je pripravljeno orodje, ki ga podjetje ponudi razvijalcem, da lahko uporabijo njegovo storitev ali platformo, ne da bi vse gradili od začetka. Običajno vključuje programsko knjižnico za določen programski jezik, dokumentacijo in primere ter včasih dodatna orodja, na primer pripomočke za testiranje. Ko vaša aplikacija »uporablja Stripe SDK«, to pomeni, da vaša koda kliče Stripejeve vnaprej pripravljene funkcije, namesto da bi vsak zahtevek do Stripejevega API-ja pisala ročno.

Zakaj so SDK-ji pomembni, ko gradite z AI

Ko AI graditelja prosite, naj doda plačila, klepet z AI, zemljevide ali e-pošto, bo ta običajno namestil SDK ponudnika in napisal nekaj vrstic, ki ga kličejo. Če veste, kaj je SDK, lahko:

• Razumete, kaj se dodaja v vaš projekt. SDK je odvisnost – zunanja koda, na katero se vaša aplikacija zdaj opira.
• Prepoznate potrebno nastavitev. Skoraj vsak SDK potrebuje API ključ, mnogi pa imajo ločeni »strežniški« in »brskalniški« različici s popolnoma različnimi pravili, kateri ključi so varni za uporabo.
• Zahtevate pravo stvar. »Uporabi uradni Stripe SDK na strežniku« je jasnejše navodilo kot »dodaj Stripe«.
• Berete napake. Mnoge napake v aplikacijah, zgrajenih z AI, nastanejo zato, ker je SDK napačno nastavljen, zastarel ali uporabljen na napačnem mestu.

Vsakdanja primerjava

Predstavljajte si, da želite namestiti police.

• API so pravila stavbe: katere stene zdržijo vijake, kakšno obremenitev prenesejo in kje so cevi. Lahko bi delali samo po teh pravilih, vse merili in vrtali sami.
• SDK je komplet police v razstavljeni obliki od istega podjetja, ki je naredilo stene: vnaprej izrezani deli, pravi vijaki, nosilec, ki natančno ustreza njihovim stenam, in navodila.

Še vedno se odločite, kam polico postaviti in kaj nanjo dati. Komplet vam le prihrani rezanje lesa in ugibanje velikosti vijakov – in manj verjetno je, da boste zadeli vodno cev.

SDK proti API-ju proti knjižnici proti ogrodju

Ti pojmi se prekrivajo, kar mnoge zmede:

SDK običajno vsebuje knjižnico, ta knjižnica pa običajno kliče API. Pri spletnih storitvah se »SDK« in »odjemalska knjižnica« pogosto uporabljata zamenljivo.

Nekateri SDK-ji niso namenjeni spletnim storitvam. Apple in Google objavljata SDK-je za gradnjo aplikacij za iOS in Android, ki vključujejo prevajalnike, simulatorje in kodo platforme. Ideja je enaka: vse, kar potrebujete za gradnjo za njuno platformo, v enem kompletu.

Kaj SDK naredi namesto vas

Tu je ista naloga – ustvarjanje stranke pri ponudniku plačil – narejena na dva načina.

Brez SDK-ja mora vaša koda sama sestaviti HTTP zahtevek: nastaviti URL, dodati tajni ključ v pravilno glavo, oblikovati podatke, kot jih API pričakuje, jih poslati, preveriti statusno kodo, razčleniti odgovor in ob motnjah v omrežju ponoviti poskus.

S SDK-jem je to bliže eni vrstici:

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

Za to vrstico SDK poskrbi za:

• Avtentikacijo – pravilno pripenjanje ključa na vsak zahtevek
• Oblikovanje podatkov – pretvorbo vaših podatkov v obliko, ki jo API pričakuje, in odgovora nazaj v objekte
• Napake – pretvorbo statusnih kod v jasne vrste napak, ki jih lahko vaša koda ujame
• Ponovne poskuse – varno ponovitev zahtevka, ki ne uspe zaradi začasnih razlogov (mnogi uradni SDK-ji to počnejo)
• Tipe – v TypeScriptu urejevalniku pove, katera polja obstajajo, da se napake pokažejo, preden zaženete kodo

Praktičen primer: dodajanje odgovorov z AI v podporno aplikacijo

Graditelju z AI rečete: »Ko stranka odda podporni zahtevek, ustvari predlagan odgovor z AI modelom.«

1. AI namesti uradni SDK ponudnika modela kot paket v vaš projekt (pri JavaScript projektih iz registra npm).
2. Dodate API ključ ponudnika kot tajnost projekta. SDK ga na strežniku prebere iz okoljske spremenljivke.
3. AI napiše strežniško pot, ki pokliče SDK z besedilom zahtevka in kratkim navodilom, ter shrani predlagani odgovor v bazo.
4. Brskalnik nikoli ne vidi ključa; kliče le vašo lastno strežniško pot.

Če ponudnik kasneje spremeni svoj API, običajno izda novo različico SDK-ja. Posodobitev paketa – in preverjanje opomb ob izdaji glede prelomnih sprememb – je pogosto vse, kar je potrebno.

Ključni pojmi

Pogoste zmote

• »API in SDK sta isto.« API je vmesnik storitve; SDK je udobna plast nad njim. Večini spletnih API-jev lahko pošljete zahtevke tudi brez SDK-ja – le da je več dela.
• »Če je SDK nameščen, je integracija končana.« Še vedno potrebujete račun pri ponudniku, prave ključe in kodo, ki obravnava, kaj se zgodi, ko stvari spodletijo.
• »Vsak paket s pravim imenom je uradni.« Napadalci včasih objavijo ponarejene pakete s podobnim imenom. Natančno ime paketa preverite v dokumentaciji ponudnika.
• »SDK v brskalniku lahko uporabi moj tajni ključ.« Nikoli. Vse v brskalniški kodi je obiskovalcem vidno. Tajni ključi sodijo samo v kodo na strežniku – glejte kako varovati API ključe.
• »SDK-jev ni treba nikoli posodabljati.« Stare različice ne prejemajo popravkov in sčasoma prenehajo delovati, ko ponudniki ukinejo stare različice API-ja.

Kaj vprašati svojega graditelja z AI

• »Uporabi uradni SDK ponudnika, ne posrednika tretje osebe. Povej mi natančno ime paketa in različico, ki si jo namestil.«
• »Uporabi SDK samo na strežniku in ključ preberi iz okoljske spremenljivke.«
• »Kateri deli tega SDK-ja tečejo v brskalniku in kateri ključi se tam uporabljajo?«
• »Kaj se zgodi, če klic SDK-ja ne uspe ali časovno poteče? Uporabniku pokaži jasno sporočilo in zabeleži napako.«
• »Naštej vse SDK-je in pakete, od katerih je odvisna ta aplikacija, in za kaj je vsak.«
• »Preveri, ali je kateri od naših SDK-jev zastarel ali ima znane varnostne težave.«

SDK-ji v Mythex

Agent Mythex lahko namešča pakete v peskovnik vašega projekta z običajnim upravljalnikom paketov za vaš sklad, vključno s SDK-ji ponudnikov – poimenujte paket in funkcijo, za katero ga želite. Glejte Uporaba npm paketov. Mythex ne ponuja kataloga vnaprej pripravljenih integracij za vašo aplikacijo: tajni ključ ponudnika shranite kot tajnost projekta in agenta prosite, naj storitev kliče s strežniške strani, kot je opisano v Povežite katerikoli API.

Za plast pod SDK-ji preberite kaj je API. Za dve pogosti funkciji, ki temeljita na SDK-jih, glejte kako dodati plačila v aplikacijo in kako uporabljati LLM API-je.

Vprašanja