Mi a REST API jelentése? Mire használjuk?

A REST API-kat sokféle célra használják, beleértve az adatszolgáltatást, az alkalmazásintegrációt, a mobilalkalmazások fejlesztését, a mikroszolgáltatások kommunikációját és a webhookok létrehozását. Ezek az interfészek alapvető fontosságúak a modern informatikában, mivel lehetővé teszik az alkalmazások közötti kapcsolatot és a szolgáltatások egymás közötti hatékony használatát. Ismerkedjünk meg a REST API használatával és működésével! 🙂

1. Mi a REST API jelentése?

REST = Representational State Transfer. Ez egy szoftverarchitektúra-stílus, ami irányelveket ad arra vonatkozóan, hogy a webes rendszerek hogyan kommunikáljanak az interneten keresztül.

API = Application Programming Interface. Olyan interfész, amit más programok (kliensek) egy adott programrendszer elérésére, használatára tudnak alkalmazni.

Tehát a REST API egy olyan API, amely a REST elveit követi. Egy REST API-n keresztül egy alkalmazás lehetővé teszi más alkalmazások vagy szolgáltatások számára, hogy kommunikáljanak vele HTTP kérések segítségével. Ezek a kérések lehetnek GET, POST, PUT, DELETE stb. parancsok formájában, amelyek lehetővé teszik az adatok lekérését, módosítását, hozzáadását vagy törlését az adott alkalmazásban vagy szolgáltatásban.

2. A REST API összetevői

Erőforrások: a REST a webes adatokat erőforrásokként kezeli. Például egy „felhasználó”, egy „termék” vagy egy „blogbejegyzés” mind különböző erőforrás típus lehetne. Minden erőforrás egyedi azonosítóval (pl. URL-lel) rendelkezik.

HTTP metódusok: a kliensek ezekkel a HTTP metódusokkal fejezik ki a szándékukat egy adott erőforrással kapcsolatban:

• GET: erőforrás lekérése
• POST: új erőforrás létrehozása
• PUT: meglévő erőforrás frissítése
• DELETE: erőforrás törlése

HTTP státusz kódok: a szerver válaszai ezekben a HTTP állapotkódokban jelzik vissza a kliensnek a kérés eredményét (pl. siker, hiba).

Állapotmentesség: a szervernek nem kell tárolnia a kliensek előző kéréseit, minden kérés önálló egységként működik.

JSON formátum: a REST API-k gyakran JSON formátumot használnak az adatok cseréjéhez, mert ez könnyen értelmezhető mind ember, mind számítógép számára.

Példa a REST API használatára:

Képzeld el, hogy le szeretnéd kérni egy online áruház terméklistáját. Ehhez a következő REST API híváshoz hasonló történhet:

GET https://api.aruhaz.hu/termekek

A szerver válasza erre egy JSON formátumú lista lesz a termékekről, azok adataival. A REST API-k alapvető szerepet játszanak a modern web- és mobilalkalmazások fejlesztésében, lehetővé téve a zökkenőmentes kommunikációt a különböző szoftverkomponensek között.

3. A REST API jelentősége

1. Univerzális integrálhatóság

• Platform- és nyelvfüggetlenség: a REST alapvetően a HTTP protokollra épül, ezért nem kötődik semmilyen programozási nyelvhez vagy operációs rendszerhez. A különböző technológiával készült rendszerek zökkenőmentesen integrálhatók REST API-kon keresztül.
• Webes szabványok használata: az API-k HTTP-t, JSON-t, és egyéb általánosan használt webes szabványokat alkalmaznak, így könnyen beilleszthetők a meglévő webinfrastruktúrába.

2. Skálázhatóság

• Állapotmentesség: a szervernek nem kell tárolnia egy adott kliens előző kéréseit. Ez lehetővé teszi, hogy a rendszer vízszintesen skálázható legyen (több szerver bevonható), a megnövekedett terhelést is kiszolgálva.
• Gyorsítótárazás: a REST válaszok gyorsítótárazhatók, így javítva a teljesítményt és csökkentve a terhelést a szervereken.

3. Rugalmasság és fejleszthetőség

• Elválasztott kliens és szerver: a kliens (pl. weboldal) és a szerver (adatbázisokat kezelő back-end) logikája függetlenül fejleszthető és módosítható, amíg a köztük lévő REST API kapcsolat érvényes. Ez felgyorsítja a fejlesztési folyamatot több csapat együttműködésekor is.
• Könnyű alkalmazkodás: a változó követelményekhez rugalmasan tud alkalmazkodni a rendszer, hisz a REST API-k képesek új funkcionalitásokat, adatformátumokat kiszolgálni anélkül, hogy a meglévő fogyasztókat befolyásolnák.

4. REST API működése

A kliens (pl. egy weboldal, mobilalkalmazás vagy egy másik szerver) meghatározza, hogy mit szeretne elérni a szerveren lévő erőforrással. Egy kliensoldali kérésben a következők szerepelnek:

• URL (végpont): ez jelzi a cél erőforrást, például: https://api.orvosinaplo.hu/betegek/12345 (adott páciens lekérdezése)
• HTTP metódus: jelzi a kívánt műveletet, például:
  • GET: erőforrás lekérése
  • POST: új erőforrás létrehozása
  • PUT: meglévő erőforrás módosítása
  • DELETE: erőforrás törlése
• Fejlécek (Headers): opcionális további metaadatok:
  • Authorization: hitelesítési token felhasználó azonosításához
  • Content-Type: a küldött adatok formátumának meghatározása (pl. application/json)
• Törzs (Body): főleg POST és PUT kéréseknél, tartalmazza az átadni kívánt adatokat.

Ezután elkezdődik a kérés feldolgozása a szerveren. A szerver ellenőrzi, hogy jogosult-e a kliens erre a műveletre (hitelesítés), majd értelmezi a kérést, és végrehajtja a szükséges műveleteket:

• Adatok kiolvasása az adatbázisból
• Adatok módosítása
• Más belső szolgáltatások meghívása

A szerver előkészíti a választ. Ez a következőket tartalmazhatja:

• HTTP státuszkód 200 OK: Sikeres művelet.
• 401 Unauthorized: Nincs megfelelő hitelesítés.
• 404 Not Found: Nem található a kért erőforrás.
• 500 Internal Server Error: Szerveroldali hiba.
• Fejlécek: metaadatokat tartalmazhatnak, pl. a válasz tartalomtípusáról.
• Törzs: a válasz törzsében szerepelnek a ténylegesen kért adatok (legtöbbször JSON formátumban).

A kliens megkapja és feldolgozza a választ:

• Státuszkód ellenőrzése: a kliens megnézi, hogy sikeres volt-e a kérés.
• Válaszfeldolgozás: a kapott adatokat értelmezi a válasz törzséből.

Példa: egyszerű blog REST API használata. Képzelj el egy REST API-t, mely egy blog kezelését teszi lehetővé.

Új blogbejegyzés közzététele: POST https://api.blogom.hu/bejegyzesek
Content-Type: application/json

{  
    "cim": "A REST lenyűgöző",
    "szoveg": "Ebben a cikkben megvizsgáljuk...",
    "cimkek": ["API", "webfejlesztés"]
}

A REST API-k lényege ez a kérés-válasz alapú kommunikáció, ami szabványos módon engedélyezi a különböző szoftverkomponensek közötti adatcserét.

5. Mi az a JSON?

Jelentése: JavaScript Object Notation (JavaScript Objektum Jelölés).

Formátum: könnyű, szövegalapú adatcsere formátum, amely ember és gép számára egyaránt könnyen olvasható és értelmezhető.

Eredet: a JSON a JavaScript szintaxisából származik, az objektumok ábrázolására szolgál, de mára nyelvfüggetlen szabvány lett.

Népszerűség az API-kban: nagyon gyakran használják adatcseréhez REST API-kban az egyszerűsége miatt.

A JSON szerkezete:

• Kulcs-érték párok: a JSON legfontosabb építőköve.
  • Kulcs: egy szöveges karakterlánc (sztring) idézőjelek között, mely megnevezi az adatot (pl. „nev”).
  • Érték: A kulcshoz tartozó adat. Lehet:
    • Sztring (idézőjelek között)
    • Szám
    • Logikai érték (true vagy false)
    • Tömb (szögletes zárójelek között felsorolt értékek)
    • Objektum (számos kulcs-érték párt tartalmazó szerkezet kapcsos zárójelek között)
    • null (üres értéket jelöl)

JSON példa: egy személy adatait ábrázolhatjuk JSON-ban így:

{
  "nev": "Kiss János",
  "eletkor": 30,
  "cim": {
    "utca": "Fő út",
    "hazszam": 12,
    "varos": "Budapest"
  },  
  "baratok": ["Péter", "Zsuzsa", "Ági"]
}

6. Összefoglaló

A REST API (Representational State Transfer Application Programming Interface) egy programozási interfész, amely lehetővé teszi két különböző rendszer vagy alkalmazás között a kommunikációt az interneten keresztül.

A REST API-t általában HTTP protokollon keresztül használják, és az egyik leggyakoribb módszer a webes szolgáltatásokhoz és alkalmazásokhoz való kapcsolódásra.

Segítségével az alkalmazások képesek adatok lekérdezésére, frissítésére vagy törlésére egy távoli szerverről, vagy éppen adatok küldésére a távoli szervernek.

Hibát találtál? Írj nekünk az alábbi e-mail címre: szerk@kiszervezettmarketing.hu

7. Gyakran ismételt kérdések és válaszok