Generated Type-Safe Client SDKs Released

! Ovaj članak sadrži tehnički žargon

Šta je novo

U našem TypeScript migration post, spomenuli smo da dolaze generisani klijentski SDK‑ovi. Evo ih.

FastComments sada isporučuje zvanične, tip‑sigurne SDK‑ove za deset jezika:

• TypeScript / JavaScript (npm)
• Python (GitHub)
• Rust (crates.io)
• Go (Go modules)
• Java (Maven)
• PHP (Composer)
• Ruby (RubyGems)
• Swift (Swift Package Manager)
• C++ (CMake)
• Nim (Nimble)

Svaki SDK se generiše iz iste OpenAPI specifikacije koju naš server proizvodi. Tipovi, potpisi metoda i modeli zahteva/odgovora automatski ostaju sinhronizovani sa stvarnim API‑jem. Vaš kompajler hvata tipografske greške u imenima polja i nedostajuće parametre pre nego što vaš kod ikada pošalje mrežni zahtev.

Kako funkcioniše

TypeScript migracija je bila preduslov za ovo. Sada kada je naš serverski kod potpuno tipizovan, koristimo our fork of TSOA da generišemo OpenAPI 3.0 specifikaciju direktno iz naših kontrolera ruta. Ta specifikacija se prosleđuje OpenAPI Generator da proizvede klijentske biblioteke za svaki jezik.

Kada se API promeni, naš alat otkriva razliku u specifikaciji, regeneriše pogođene SDK‑ove, pokreće testove za svaki jezik i automatski otvara pull zahteve. Napravili smo mali upravljački alat u Nim‑u koji orkestrira ciklus ažuriranja‑testiranja‑izdavanja kroz svih deset repozitorijuma.

Šta se nalazi u svakom SDK‑u

Svaki SDK pruža dve API klase:

• DefaultApi: autentifikovani krajnji tačke koje zahtevaju vaš API ključ. Koristite ih na serveru za moderaciju, upravljanje korisnicima, analitiku i masovne operacije.
• PublicApi: neautentifikovane krajnje tačke koje je sigurno pozivati iz pregledača i mobilnih aplikacija. One pokrivaju preuzimanje komentara, objavljivanje, glasanje i druge operacije usmerene ka klijentu.

Svi SDK‑ovi takođe uključuju SSO alate za integraciju sa vašim postojećim sistemom autentifikacije. TypeScript SDK dodatno pruža pretplate na događaje u realnom vremenu za live komentarisanje.

Dokumentacija

Puna API dokumentacija je dostupna na docs.fastcomments.com. Svaki SDK repozitorijum takođe sadrži generisanu dokumentaciju koja pokriva svaku dostupnu metodu i model.

Za SSO integraciju, pogledajte naš SSO guide. Svi deset SDK‑ova uključuju SSO pomoćnike koji koriste njihove native biblioteke kriptografije.

Zaključak

Imati potpuno tipizovan server učinilo je jednostavnim generisanje pouzdane OpenAPI specifikacije, a odatle generisanje klijenata za deset (i jednog dana više!) jezika bilo je uglavnom pitanje izgradnje automatizacije i unapređenja naših tip definicija kako bi bile upotrebljive, bez dodavanja previše apstrakcije koja bi usporila FastComments!

Kao i kod svih velikih izdanja, zadovoljni smo što smo mogli odvojiti vreme za optimizaciju, testiranje i pravilno izdavanje ovih SDK‑ova. Javite nam ispod ako imate bilo kakve povratne informacije ili ako postoji jezik koji biste želeli da dodamo.

Živeli!