Főoldal

"Mérnököt a mérnöktől"

A Schönherz Bázis összeköti az állást kereső és állást kínáló mérnököket.

CV küldés

Küldj önéletrajzot! Gyorsan, egyszerűen.
Megjegyzésbe írd be a pozíció nevét.
CV küldés

Iratkozz fel hírlevelünkre!

Kövess minket!

Kövess minket!

Hírek

Útmutató API készítéséhez, avagy hogyan hozz létre API-t a mobilalkalmazásodhoz
Útmutató API készítéséhez, avagy hogyan hozz létre API-t a mobilalkalmazásodhoz

A jelenlegi innovatív szférában hasznos ismeretterjesztő tartalmak sokasága került fel az internetre, melyek segítenek megfelelő APIk létrehozásában, hogy lehetővé tegyük az alkalmazás kommunikációját specifikus webes vagy felhőalapú szolgáltatásokkal. Habár ezen koncepciók és gyakorlatok évekig segíthették a mobil API tervezőket, mások egyszerűen csak eltűntek az idő múlásával. Mindenkinek, aki egy mobil app teljesítményét szeretné javítani, meg kéne fontolnia és próbálnia a legtöbbet kihozni a szerveroldali APIkból a jobb fogyasztói élmény érdekében. Ez a cikk bemutat pár igazolt módszert a kiváló API megtervezésére, mely biztosítja a felhasználók kiszolgálását alkalmazás- és adaterőforrásokkal, távolról.


Optimizáld a LocalStorage-et és a Caching-et

Ha le akarod csökkenteni a lassú mobilhálózatok által az alkalmazásod teljesítményére gyakorolt negatív hatást, tárold a CSS-t, HTML-t és minden képet a localStorage-ban. Sok mobil app tulajdonos vett észre csökkenést a HTML adatok átlagos méretében, 200KB-ról mindössze 30KB-ra. Ezen felül ideális az összes változatlan adatot, amilyen a fő navigáció vagy a kategóriák (hogy említsünk párat) az alkalmazásba átvinni. Ezt alkalmazva nem kell egy kört tenned a választott mobilhálózaton, megspórolva az adatok előre betöltését (mint a lekérdezések, felhasználói adatok és tördelt adatok), melyek extra kérés nélkül töltődnének az eszközre.


Az eredmények tördelése kötelező

A tördelés egy egyedi technika, mely megakadályozza számos felhasználó több ezer bejegyzésének egyszerre történő visszatérését. Ezért ne felejtsd el tördelni az eredményeket, melyek dolgok egy speciális listáját adják vissza. Kötegekben könnyedén kezdeményezheted adatgyűjteményeid és lekérdezéseid manuális tördelését a LIMIT és OFFSET kulcsszavak használatával. Egy dolgot mindig észben kell tartanod: kötelező megjeleníteni a metaadatokat minden tördelt eredménynél, amikor azt visszaadod. Ez HTTP Link-Header-ök használatával jól megvalósítható. Fontos megérteni, hogy ez a header tartalmazni fogja az eredményhalmaz kezdő, utolsó, következő és előző oldalának teljes URL-jét, kényelmesebbé téve több tördelt eredmény egyidejű kezelését a kliensek számára. Egyszerű elemzés is megvalósítható az eredmények valós idejű tördelésével.


Használj JSON-t

A POST információk URL-kódolt adatként való továbbításának ideje lejárt. Mára a dolgok megváltoztak, és épp ezért javasolt JSON-t használni az adatok végpontokba küldéséhez. Ezt a módszert alkalmazva olvashatóbbá és könnyebben összerakhatóvá teszed a kéréseket a felhasználó számára. A Rails pedig a JSON-kódolt paraméterek gyorsabb kezelésére szolgál. A Rails ActionController automatikusan kicsomagolja a JSON-nal szállított adatokat, lehetővé téve a hozzáférést params hash használatával.


Ne hanyagold el a nem publikus API hitelesítését

Tele van az internet hackerekkel. Ha egy nem publikus API-t készítesz, akkor kell lennie hozzá egy akadálymentes hitelesítési rendszernek is. A hagyományos TokenAuthenticatable kezdeményezéssel ellentétben, melyet privát APIk hitelesítési mechanizmusában használnak, ideálisabb hasznosítani a HTTP elsődleges hitelesítését. Ez a minden HTTP kliensbe implementált alapvető hitelesítési folyamat az API hozzáféréséhez is elvár érvényes felhasználónevet és jelszót. Emellett privát hozzáférési tokenekkel bejelentkeztetheted a felhasználóidat az APIba.


Győződj meg róla, hogy megfelelően elkülönített verziók vannak már a kezdetektől

Mivel az APInak egy ponton túl változásokon kell keresztülmennie, a te dolgod megfelelően verziókra bontani. Mivel az API egy szerződésként működik a backend és az őt használó alkalmazások között, ezért elérhetőnek kell lennie verziók széles választékában. Ezt követve folytathatod majd az alkalmazás használatát annak verziójának változása után is, hiszen az app képes így kezelni az APIban bemutatott változtatásokat. De ha nem bontod verziókra az API-t, akkor az alkalmazás használhatatlanná válik minden egyes alkalommal, amikor változtatsz valamit rajta.


Építs be gyakoriság-korlátot már az API tervezés korai szakaszában

Habár a korai szakaszban, amikor a kliensek csak használni kezdik az API-t, még minden nyugodt, az irányítás gyorsan kicsúszhat a kezeid közül, ha nagy sikert arat az appod. Hiszen ez azt jelenti, hogy egyre több és több ember próbálja majd integrálni az API-t az infrastruktúrájába és munkafolyamatába, ezáltal a te végpontodat hívja és ugyanazt az URL-t kéri újra meg újra, több ezerszer óránként. Ez az a pont, ahol egy gyakoriság-korlát beépítésének koncepciója reménysugarat jelenthet. Egy átlagos korlát megelőzheti a szerverek lehalását, és tisztább képet mutat a felhasználóknak arról, hogy hogyan lehet még precízebben használni az API-t. A nagyobb infrastruktúrákban a Nginx limit_req szolgálhat jó megközelítéssel a korlát létrehozásához; a Redis pedig csodákat művelhet a többivel.


Legyen társítva hozzá megfelelő dokumentáció

A dokumentáció az API terv legfőbb része. A félreérthető, vagy nem tiszta dokumentáció frusztrálhatja a fejlesztőket, annyira, hogy a végén hanyagolják majd a te terméked, és mást választanak helyette. Ezért fontos, hogy szép, hibamentes dokumentációt kínáljunk, mely hanyagolja a hosszú kódrészleteket. A legtöbb fejlesztő a példák közötti böngészést preferálja. Győződj meg róla, hogy ennek megfelelően készíted el, hogy jobban érthető legyen maga az API és használhatósága. Ha mutatni akarsz kódrészleteket is, akkor jobb, ha ezt különböző tesztforgatókönyvekben teszed. Ez hitelesíteni fogja a dokumentációd frissített változatát minden alkalommal, amikor az API módosításra kerül. A megfelelő dokumentáció létrehozásához keresd a híres kész eszközöket, mint amilyen az Apipie, vagy válassz egy egyedileg készített megoldást.


(Forrás)

***

Ha Te is kreatív, kihívásokkal teli mérnök állást keresel minõségi munkáltatónál, jó helyen jársz, mert a Schönherz Bázis épp azért jött létre, hogy Neked segítsen.
Gyere, nézz szét aktuális állásaink között!