Kas ir SDK? Programmatūras izstrādes komplekti vienkārši izskaidroti

SDK (programmatūras izstrādes komplekts) ir gatavs rīku komplekts, ko uzņēmums nodrošina izstrādātājiem, lai viņi varētu izmantot tā pakalpojumu vai platformu, neveidojot visu no nulles. Parasti tajā ir koda bibliotēka konkrētai programmēšanas valodai, dokumentācija un piemēri, dažkārt arī papildu rīki, piemēram, testēšanas utilītas. Kad jūsu lietotne „izmanto Stripe SDK”, tas nozīmē, ka jūsu kods izsauc Stripe iepriekš sagatavotās funkcijas, nevis raksta katru pieprasījumu Stripe API ar rokām.

Kāpēc SDK ir svarīgi, veidojot ar MI

Kad lūdzat MI lietotņu veidotājam pievienot maksājumus, MI tērzēšanu, kartes vai e-pastu, tas parasti instalē attiecīgā pakalpojumu sniedzēja SDK un uzraksta dažas rindas, kas to izsauc. Ja zināt, kas ir SDK, tas palīdz:

• Saprast, kas tiek pievienots jūsu projektam. SDK ir atkarība — ārējs kods, uz kuru jūsu lietotne tagad balstās.
• Pamanīt, kāda uzstādīšana tam vajadzīga. Gandrīz katram SDK vajag API atslēgu, un daudziem ir atsevišķas „servera” un „pārlūkprogrammas” versijas ar atšķirīgiem noteikumiem par to, kuras atslēgas ir drošas lietošanai.
• Pieprasīt pareizo lietu. „Izmanto oficiālo Stripe SDK serverī” ir skaidrāka instrukcija nekā „pievieno Stripe”.
• Lasīt kļūdas. Daudzas kļūdas MI veidotās lietotnēs rodas tāpēc, ka SDK ir nepareizi konfigurēts, novecojis vai izmantots nepareizā vietā.

Ikdienas salīdzinājums

Iedomājieties, ka gribat uzkārt plauktus.

• API ir ēkas noteikumi: kurās sienās var ieskrūvēt skrūves, cik lielu slodzi tās notur, kur atrodas caurules. Jūs varētu strādāt tikai pēc šiem noteikumiem, visu mērot un urbjot pašrocīgi.
• SDK ir plauktu komplekts no tā paša uzņēmuma, kas izveidoja sienas: iepriekš sagatavotas detaļas, pareizās skrūves, kronšteins, kas precīzi der viņu sienām, un instrukciju bukletu.

Jūs joprojām izlemjat, kur plaukts stāvēs un kas uz tā tiks likts. Komplekts tikai ietaupa jums koka griešanu un skrūvju izmēru minēšanu — un ir mazāka iespēja, ka beigās caurumu iedursiet ūdensvadā.

SDK pret API pret bibliotēku pret ietvaru

Šie termini pārklājas, un tas daudziem mulsina:

SDK parasti satur bibliotēku, un šī bibliotēka parasti izsauc API. Tīmekļa pakalpojumu gadījumā vārdus „SDK” un „klienta bibliotēka” bieži lieto kā sinonīmus.

Daži SDK nemaz nav saistīti ar tīmekļa pakalpojumiem. Apple un Google publicē SDK iOS un Android lietotņu izstrādei, un tajos ir kompilatori, simulatori un platformas kods. Ideja ir tā pati: viss, kas vajadzīgs izstrādei konkrētai platformai, vienā komplektā.

Ko SDK dara jūsu vietā

Šeit ir viens un tas pats uzdevums — izveidot klientu maksājumu pakalpojumu sniedzējā — divos veidos.

Bez SDK jūsu kodam pašam jāveido HTTP pieprasījums: jāuzstāda URL, jāpievieno slepenā atslēga pareizajā galvenē, jāsagatavo dati tā, kā to sagaida API, jānosūta, jāpārbauda statusa kods, jāizlasa atbilde un jāapstrādā atkārtotas mēģinājumi, ja tīkls uz brīdi pārtrūkst.

Ar SDK tas ir tuvāk vienai rindai:

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

Aiz šīs rindas SDK apstrādā:

• Autentifikāciju — pareizu atslēgas pievienošanu katram pieprasījumam
• Datu formatēšanu — datu pārvēršanu tādos, kā tos sagaida API, un atbildes atpakaļ objektos
• Kļūdas — statusa kodu pārvēršanu skaidros kļūdu tipos, ko jūsu kods var notvert
• Atkārtotus mēģinājumus — drošu atkārtošanu, kad pieprasījums neizdodas īslaicīgu iemeslu dēļ (daudzi oficiālie SDK to dara)
• Tipus — TypeScript valodā tie pasaka redaktoram, kādi lauki pastāv, tāpēc kļūdas parādās pirms koda palaišanas

Praktisks piemērs: MI atbildes pievienošana atbalsta lietotnei

Jūs lūdzat MI lietotņu veidotājam: „Kad klients iesniedz atbalsta pieteikumu, ģenerē ieteicamu atbildi, izmantojot MI modeli.”

1. MI instalē modeļa pakalpojumu sniedzēja oficiālo SDK kā pakotni jūsu projektā (JavaScript projektos — no npm reģistra).
2. Jūs pievienojat pakalpojumu sniedzēja API atslēgu kā projekta noslēpumu. SDK to nolasa no vides mainīgā serverī.
3. MI uzraksta servera maršrutu, kas izsauc SDK ar pieteikuma tekstu un īsu norādi, un saglabā ieteikto atbildi datubāzē.
4. Pārlūkprogramma nekad neredz atslēgu; tā izsauc tikai jūsu pašu servera maršrutu.

Ja pakalpojumu sniedzējs vēlāk maina savu API, tas parasti izlaiž jaunu SDK versiju. Pakotnes atjaunināšana — un izlaiduma piezīmju pārbaude, vai nav pārtraucošu izmaiņu — bieži ir viss, kas vajadzīgs.

Galvenie termini

Biežākie maldi

• „SDK un API ir viens un tas pats.” API ir pakalpojuma saskarne; SDK ir ērtības slānis virs tās. Vairumu tīmekļa API var izsaukt arī bez SDK — tikai tas prasa vairāk darba.
• „Ja SDK ir instalēts, integrācija ir pabeigta.” Jums joprojām vajag kontu pie pakalpojumu sniedzēja, pareizās atslēgas un kodu, kas apstrādā gadījumus, kad kaut kas neizdodas.
• „Jebkura pakotne ar pareizo nosaukumu ir oficiālā.” Uzbrucēji dažkārt publicē līdzīgas pakotnes ar viltotiem nosaukumiem. Pārbaudiet pakalpojumu sniedzēja dokumentācijā precīzu pakotnes nosaukumu.
• „Pārlūkprogrammas SDK var izmantot manu slepeno atslēgu.” Nekad. Viss pārlūkprogrammas kodā ir redzams apmeklētājiem. Slepenās atslēgas pieder tikai servera kodam — skatiet kā sargāt API atslēgas.
• „SDK nekad nav jāatjaunina.” Vecas versijas vairs nesaņem labojumus un beigu beigās pārstāj darboties, kad pakalpojumu sniedzēji izslēdz vecās API versijas.

Ko jautāt savam MI veidotājam

• „Izmanto pakalpojumu sniedzēja oficiālo SDK, nevis trešās puses apvalku. Pasaki precīzu instalētās pakotnes nosaukumu un versiju.”
• „Izmanto SDK tikai serverī un nolasi atslēgu no vides mainīgā.”
• „Kuras šī SDK daļas darbojas pārlūkprogrammā un kurām atslēgām?”
• „Kas notiek, ja SDK izsaukums neizdodas vai beidzas laiks? Parādi lietotājam skaidru ziņojumu un ieraksti kļūdu žurnālā.”
• „Uzskaiti katru SDK un pakotni, no kurām šī lietotne ir atkarīga, un norādi, kam katra no tām paredzēta.”
• „Pārbaudi, vai kāds no mūsu SDK ir novecojis vai ir zināmas drošības problēmas.”

SDK Mythex

Mythex aģents var instalēt pakotnes jūsu projekta vidē, izmantojot jūsu tehnoloģiju steka parasto pakotņu pārvaldnieku, tostarp pakalpojumu sniedzēju SDK — nosauciet pakotni un funkciju, kam tā vajadzīga. Skatiet Npm pakotņu lietošana. Mythex neizplata gatavu integrāciju katalogu jūsu lietotnei: jūs saglabājat pakalpojumu sniedzēja atslēgu kā projekta noslēpumu un lūdzat aģentu izsaukt pakalpojumu servera pusē, kā aprakstīts Integrē jebkuru API.

Lai iepazītos ar slāni zem SDK, lasiet kas ir API. Divām biežākajām funkcijām, kas balstītas uz SDK, skatiet kā pievienot maksājumus savai lietotnei un kā lietot LLM API.

Jautājumi