Postman és használata

Postman

A Postman egy rendkívül népszerű eszköz az IT fejlesztők és tesztelők körében, amely API-k fejlesztésére, tesztelésére és dokumentálására használható.

A Postman rugalmasságának és funkcionalitásának köszönhetően az egyik legjobb eszköz a modern API-fejlesztési és tesztelési folyamatokhoz. Használatával időt takaríthatunk meg, növelhetjük a munkafolyamat hatékonyságát, és biztosíthatjuk az API-k magas színvonalát.

Fejlesztői nézőpontból

1. API-fejlesztés támogatása

Kérés létrehozása és tesztelése: Gyorsan létrehozhatók és tesztelhetők HTTP-kérések (GET, POST, PUT, DELETE stb.).

Különböző formátumok támogatása: Támogatott formátumok, például JSON, XML vagy egyszerű szöveg.

Kódgenerálás: A Postman automatikusan generál kódrészleteket (pl. cURL, Python, JavaScript stb.) a létrehozott API-hívásokból.

Környezetek kezelése: Különböző környezetek (pl. fejlesztés, tesztelés, éles rendszer) konfigurálhatók változókkal, például URL-ek vagy hitelesítési adatok cseréjéhez.

2. Integráció más eszközökkel

CI/CD integráció: A Newman CLI segítségével a Postman szkriptek futtathatók CI/CD pipeline-ban, például Jenkins, GitHub Actions vagy GitLab CI használatával.

Webhooks és API-k: Közvetlenül integrálható más rendszerekkel és eszközökkel.

API dokumentáció: Automatikus API-dokumentáció generálása és közzététele.

3. Teljesítményoptimalizálás

API validáció: Könnyen ellenőrizhető az API válaszstruktúrája és a válaszidők.

Mock server létrehozása: Az API végpontok szimulálhatók, még mielőtt azokat ténylegesen implementálnák.

Tesztelői nézőpontból

1. Automatizált tesztelés

Test script-ek írása: A Postman JavaScript-alapú szkriptelést támogat a kérések előtti és utáni eseményekhez.

Példa: Validálható a HTTP státuszkód, válaszidő, válaszstruktúra vagy akár egyéni üzleti logika.

Kollekciók futtatása: Az API-k kollekciókba rendezhetők, amelyek sorozatosan vagy párhuzamosan futtathatók.

2. Adatvezérelt tesztelés (Data-Driven Testing)

CSV/JSON importálása: Tömeges tesztelés végezhető különböző bemeneti adatokkal.

Változók dinamikus kezelése: A tesztelési környezetekhez változók, például API-kulcsok vagy felhasználói adatok definiálhatók.

3. Hibakeresés

Valós idejű válaszfigyelés: Könnyen láthatók a válasz részletei (státuszkód, fejléc, válaszidő stb.).

Logok elemzése: Az API-válaszok logjai segítenek a hibák gyors lokalizálásában.

Módszerek és tippek

Verziókezelés: A Postman kollekciók exportálhatók és verziókövető rendszerekben (pl. Git) tárolhatók.

Csapatmunka: Postman Team Workspace segítségével a csapat tagjai közösen dolgozhatnak API-okon.

Mock server használata: Ideális megoldás a front-end és back-end fejlesztések szinkronizálására.

Monitorozás:

Az API-k monitorozása időzített tesztekkel, hogy biztosítsák az állandó elérhetőséget és teljesítményt.

Telepítés és beállítás

Postman telepítése

Letöltés: Látogass el a Postman hivatalos oldalára és töltsd le az operációs rendszerednek megfelelő verziót (Windows, macOS, Linux).
Telepítés: Futtasd a letöltött telepítőt és kövesd az utasításokat.
Bejelentkezés: Hozz létre egy ingyenes Postman-fiókot, vagy jelentkezz be már meglévő fiókkal.

Alapvető használat

Első lépések az API-k tesztelésében

Új kérés (Request) létrehozása:
- Kattints a "New" gombra, majd válaszd ki a Request opciót.
- Add meg a kérés nevét, és mentsd el egy új vagy meglévő kollekcióban (Collection).
URL megadása:
- Írd be az API végpont URL-jét a címmezőbe.
- Példa: https://api.example.com/users.
HTTP-módszer kiválasztása:
- Válaszd ki a megfelelő módszert: GET, POST, PUT, DELETE, stb.
Kérés testreszabása:
- Headers: Add meg a szükséges fejléc információkat, például az Authorization tokent.
- Body: Ha a kérés tartalmaz adatokat (pl. POST/PUT), válaszd ki a Body fület és add meg a tartalmat (pl. JSON formátumban).
Kérés végrehajtása:
- Kattints a Send gombra, hogy futtasd a kérést.
- Nézd meg a választ a Response ablakban (státuszkód, fejléc, test).

3. Tesztek írása és végrehajtása

Tesztek beállítása

Pre-request Script:
- Ha a kérés futtatása előtt előkészítést (pl. változók inicializálása) szeretnél, írd meg a scriptet a Pre-request Script fülön.
- Példa:
```
--- javascript

pm.environment.set("userId", "12345");
```
Teszt szkriptek hozzáadása:
- Lépj a Tests fülre, és adj hozzá egyedi ellenőrzéseket.
- Példa egy egyszerű tesztre:
```
--- javascript

pm.test("Status code is 200", function () {
    pm.response.to.have.status(200);
});
```

Kollekció létrehozása és futtatása

Kollekciók használata:
- Hozz létre egy kollekciót, amelyben összegyűjtöd az API-kat (pl. User Management API).
- Minden API-hívást hozzáadhatsz a kollekcióhoz, és ezeket sorozatban végrehajthatod.
Kollekció futtatása:
- Kattints a Runner gombra, válaszd ki a kollekciót, és futtasd le az összes API-hívást egyszerre.

Automatizált tesztelés

Adatvezérelt tesztelés

CSV vagy JSON fájl importálása:
- Adj meg bemeneti adatokat egy CSV vagy JSON fájlban (pl. több felhasználói adat teszteléséhez).
- Példa CSV tartalom:
```
----csv

userId,name
1,John Doe
2,Jane Smith
```
Adatok hozzárendelése:
- A változókat ({{userId}}, {{name}}) a kérésben használhatod.
Futtatás:
- A Runner segítségével egyszerre több tesztet futtathatsz különböző adatokkal.

Mock Server létrehozása

Mock végpont definiálása:
- Hozz létre egy új mock szervert a Postman-ben, hogy szimuláld az API válaszokat.
Válasz előkészítése:
- Add meg a várható válaszokat (státuszkód, test tartalom).
Front-end fejlesztés támogatása:
- A mock szerver URL-jét megoszthatod a front-end csapattal, hogy a valós API-k nélkül is tudjanak dolgozni.

Monitorozás és hibajavítás

API monitorozás

Időzített futtatás: Állíts be monitorokat, amelyek időközönként automatikusan lefuttatják a teszteket (pl. óránként, naponta).
Riasztások: Hiba esetén a Postman értesítéseket küldhet (e-mail vagy webhook).

Hibakeresés

Ellenőrizd a válaszokat (státuszkód, fejléc, body).
Használd a Console ablakot a részletes naplózáshoz.

Helyettesítő mely hasonló a Postman-hez, de open source:

https://github.com/hoppscotch/hoppscotch

Demo : hoppscotch.io

IT, BI, DWH, DM, AI

Keresés ebben a blogban