Mis on SDK? Tarkvaraarenduse komplekt lihtsalt selgitatud

SDK (tarkvaraarenduse komplekt) on valmis tööriistakomplekt, mille ettevõte annab arendajatele, et nad saaksid kasutada selle teenust või platvormi ilma kõike nullist ehitamata. See sisaldab tavaliselt konkreetse programmeerimiskeele koodiraamatukogu, dokumentatsiooni ja näiteid ning mõnikord lisatööriistu, näiteks testimisvahendeid. Kui sinu rakendus „kasutab Stripe'i SDK-d", tähendab see, et su kood kutsub Stripe'i valmisfunktsioone, selle asemel et kirjutada igale Stripe'i API päringule käsitsi.

Miks SDK-d AI-ga ehitades olulised on

Kui palud AI ehitajal lisada makseid, AI-vestlust, kaarte või e-kirju, installib ta tavaliselt selle pakkuja SDK ja kirjutab mõne rea koodi, mis seda kutsub. SDK mõiste tundmine aitab sul:

• Mõista, mida sinu projektile lisatakse. SDK on sõltuvus – väline kood, millest su rakendus nüüd sõltub.
• Märgata vajalikku seadistust. Peaaegu iga SDK vajab API-võtit ja paljudel on eraldi „serveri" ja „brauseri" versioonid, millel on erinevad reeglid selle kohta, millised võtmed on turvaliselt kasutatavad.
• Küsida õiget asja. „Kasuta ametlikku Stripe'i SDK-d serveris" on selgem juhis kui „lisa Stripe".
• Lugeda vigu. Paljud vead AI-ga ehitatud rakendustes tulevad sellest, et SDK on valesti seadistatud, aegunud või kasutatud vales kohas.

Igapäevane võrdlus

Kujuta ette, et tahad riiulid seinale kinnitada.

• API on hoone reeglid: millised seinad kannavad kruve, kui palju koormust need taluvad, kus on torud. Sa võiksid töötada ainult nende reeglite järgi, mõõta ja puurida kõike ise.
• SDK on sama firma seinte tootja pakutud kokkupandav riiulikomplekt: eelnevalt lõigatud osad, õiged kruvid, konsool, mis sobib nende seintele täpselt, ja juhend.

Otsustad ikka ise, kuhu riiul läheb ja mis sinna pannakse. Komplekt lihtsalt säästab sind puidu lõikamisest ja kruvide suuruse arvamisest – ning väiksema tõenäosusega lõpeb see auguga veetorus.

SDK vs API vs teek vs raamistik

Need mõisted kattuvad, mis paneb paljud segadusse:

SDK sisaldab tavaliselt teeki ja see teek kutsub tavaliselt API-t. Veebiteenuste puhul kasutatakse mõisteid „SDK" ja „klienditeek" sageli üksteise sünonüümidena.

Mõned SDK-d ei puuduta üldse veebiteenuseid. Apple ja Google avaldavad SDK-d iOS- ja Androidi rakenduste loomiseks, mis sisaldavad kompilaatoreid, simulaatoreid ja platvormikoodi. Idee on sama: kõik, mida nende platvormi jaoks ehitamiseks vajad, ühes komplektis.

Mida SDK sinu eest teeb

Vaatame sama ülesannet – kliendi loomist makseteenuse pakkujas – kahel viisil.

Ilma SDK-ta peab su kood ise koostama HTTP-päringu: määrama URL-i, lisama salajase võtme õigesse päisesse, vormindama andmed nii, nagu API ootab, saatma päringu, kontrollima olekukoodi, analüüsima vastuse ja käsitlema uusi katseid, kui võrk hetkeks katkeb.

SDK-ga on see umbes üks rida:

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

Selle rea taga käsitleb SDK järgmist:

• Autentimine – su võtme õige lisamine igale päringule
• Andmevormindus – su andmete teisendamine API nõutavale kujule ning vastuse tagasi objektideks
• Vead – olekukoodide muutmine selgeteks veatüüpideks, mida su kood saab püüda
• Uuesti proovimine – turvaline uuesti proovimine, kui päring ebaõnnestub ajutistel põhjustel (paljud ametlikud SDK-d teevad seda)
• Tüübid – TypeScripti puhul näitab SDK redaktorile, millised väljad on olemas, nii et vead ilmnevad enne koodi käivitamist

Näide: AI-vastused tugirakendusse

Palud AI ehitajal: „Kui klient esitab tugipileti, loo AI mudeli abil soovitatud vastus."

1. AI installib mudeli pakkuja ametliku SDK-d projekti paketina (JavaScripti projektides npm registrist).
2. Lisad pakkuja API-võtme projekti saladusena. SDK loeb selle serveris keskkonnamuutujast.
3. AI kirjutab serveriraja, mis kutsub SDK-d tugipileti teksti ja lühikese juhisega ning salvestab soovitatud vastuse andmebaasi.
4. Brauser ei näe kunagi võtit; see kutsub ainult sinu enda serverirada.

Kui pakkuja hiljem oma API-d muudab, avaldab ta tavaliselt uue SDK versiooni. Paketi uuendamine – ja väljalaskemärkmete kontrollimine katkestavate muudatuste osas – on sageli kõik, mis vaja on.

Põhimõisted

Levinud väärarusaamad

• „SDK ja API on sama asi." API on teenuse liides; SDK on mugavuskiht selle peal. Enamikku veebi-API-sid saab kutsuda ka ilma SDK-ta – see on lihtsalt rohkem tööd.
• „Kui SDK on installitud, on integratsioon valmis." Sul on vaja ikka kontot pakkujas, õigeid võtmeid ja koodi, mis käsitleb olukordi, kui asjad ebaõnnestuvad.
• „Iga õige nimega pakett on ametlik." Ründajad avaldavad mõnikord sarnaseid pakette. Kontrolli täpset paketi nime pakkuja dokumentatsioonist.
• „Brauseri SDK-d võivad kasutada minu salajast võtit." Mitte kunagi. Kõik brauserikoodis on külastajatele nähtav. Salajased võtmed kuuluvad ainult serveripoolsesse koodi – vt kuidas API-võtmeid turvaliselt hoida.
• „SDK-d ei vaja kunagi uuendamist." Vanad versioonid ei saa enam parandusi ning lõpuks lakkavad töötamast, kui pakkujad vanad API versioonid kasutusest kõrvaldavad.

Mida küsida oma AI ehitajalt

• „Kasuta pakkuja ametlikku SDK-d, mitte kolmanda osapoole mähist. Ütle mulle täpne paketi nimi ja versioon, mille installisid."
• „Kasuta SDK-d ainult serveris ja loe võti keskkonnamuutujast."
• „Millised selle SDK osad töötavad brauseris ja milliseid võtmeid nad kasutavad?"
• „Mis juhtub, kui SDK kutse ebaõnnestub või aegub? Näita kasutajale selget teadet ja logi viga."
• „Loetle kõik SDK-d ja paketid, millest see rakendus sõltub, ja selgita, milleks iga neist on."
• „Kontrolli, kas mõni meie SDK-dest on aegunud või sellel on teadaolevaid turvaprobleeme."

SDK-d Mythexis

Mythexi agent saab paigaldada pakette sinu projekti liivakasti, kasutades sinu tehnoloogiapinu tavalist paketihaldurit, sealhulgas pakkujate SDK-sid – nimeta pakett ja funktsioon, milleks seda tahad. Vt npm-pakettide kasutamine. Mythex ei paku sinu rakenduse jaoks valmis integratsioonide kataloogi: salvestad pakkuja võtme projekti saladusena ning palud agendil teenust serveripoolselt kutsuda, nagu on kirjeldatud lehel Integreeri mis tahes API.

SDK-de alusena olevast kihist loe mis on API. Kahe levinud SDK-põhise funktsiooni kohta vaata kuidas lisada oma rakendusele makseid ja kuidas kasutada LLM API-sid.

Küsimused