Postman: mi ez, az API tesztelése és munka a kérésekkel

Mi az a Postman és a kulcsfontosságú képességek

Postman az API-k fejlesztésére és tesztelésére szolgáló platform, amely asztali alkalmazásként (Windows, macOS, Linux) és webböngészős verzióként is elérhető. Eredetileg 2012-ben Chrome-bővítményként készült, a Postman teljes értékű ökoszisztémává nőtte ki magát monitoring-, mock-szerver- és klienskód-generálási támogatással.

Kérés- és válaszformátumok

A Postman minden HTTP-metódust támogat: GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS. A kérés törzse lehet JSON, XML, form-data, x-www-form-urlencoded és binary formátumú. A válasz szintaxiskiemeléssel, Pretty-printtel és a nyers fejlécek megtekintésének lehetőségével jelenik meg.

Hitelesítési támogatás

A beépített hitelesítési típusok közé tartozik a Bearer Token, Basic Auth, Digest Auth, OAuth 1.0, OAuth 2.0, API Key és AWS Signature. A Postman automatikusan beszúrja az Authorization fejlécet a kiválasztott típus szerint, ami felgyorsítja a védett endpointok tesztelését a tokenek kézi másolása nélkül.

A Postman felülete és navigáció

A Postman felülete az oldalsó panelből (Collections, APIs, Environments), a munkaterületből (Request Builder/Response Viewer) és az alsó panelből (Console, Runner) áll. A Params fül lehetővé teszi az URL lekérdezési paramétereinek táblázatos szerkesztését, a Headers fül pedig a HTTP-fejlécek kezelését.

Postman Console

Console (View → Show Postman Console) minden hálózati kérést és választ kronológiai sorrendben naplóz, beleértve a köztes átirányításokat és fejléceket is. Ez nélkülözhetetlen eszköz az összetett OAuth-folyamatok és átirányítási láncok hibakeresésénél, amikor a szabványos Response Viewer csak a végeredményt mutatja.

Workspaces és csapatmunka

A Postman támogatja a csapatmunkaterületeket (Workspaces) a kollekciók verziókezelésével Fork és Merge segítségével. A csapattagok kommentálhatják a kéréseket, változtatásokat javasolhatnak és valós időben szinkronizálhatják a kollekciókat. A Public Workspace lehetővé teszi az API-dokumentáció közzétételét külső fejlesztők számára.

HTTP-kérések létrehozása és küldése

Alapkérés a Postmanben a HTTP-metódus kiválasztásával és a URL címsorba való beírásával jön létre. Küldés után a válasz az alsó panelen jelenik meg állapotkóddal, végrehajtási idővel és mérettel. A kérés paramétereit a beírás során automatikusan kódolja a rendszer.

Dinamikus változók és snippettek

A URL-ben és a kérés törzsében {`{`}}$variable${`}`} formátumú dinamikus változók használhatók. A beépített {`{`}$guid${`}`}, {`{`}$timestamp${`}`} és {`{`}$randomInt${`}`} változók minden kéréshez egyedi értékeket generálnak. A kódsnippettek a Code () gombon keresztül érhetők el, amely ekvivalens kérést generál cURL, Python, JavaScript, Kotlin, Swift és más nyelveken.

// Példa Pre-request szkriptre: HMAC-aláírás generálása
const timestamp = Date.now().toString();
const secret = pm.environment.get("api_secret");
const hash = CryptoJS.HmacSHA256(timestamp, secret);
pm.request.headers.add({
    key: "X-Signature",
    value: hash.toString()
});

Kollekciók és környezeti változók

A kollekciók kapcsolódó kérések csoportjai, amelyeket projekt vagy funkcionális modul szerint egyesítenek. Minden kollekció tartalmazhat beágyazott mappákat, közös fejléceket és Pre-request szkripteket, amelyek a kollekció minden kérése előtt lefutnak. A kérések sorrendjét áthúzással lehet beállítani.

Környezeti változók és globális változók

A Postman a változók öt szintjét támogatja: global, collection, environment, data és local. A konfliktusok feloldásának prioritása — a lokálistól a globálisig. Az Environment-fájlok kulcs-érték párokat tartalmaznak a különböző környezetekhez: development, staging, production. A környezet váltása automatikusan megváltoztatja az összes URL-t és tokent.

Az API-tesztelés automatizálása szkriptekkel

Postman lehetővé teszi JavaScript-tesztek írását a Tests fülön, amelyek a válasz megérkezése után futnak le. A tesztek ellenőrzik az állapotkódot, a válasz törzsét, a fejléceket és a végrehajtási időt. Az eredmények a Test Results panelen jelennek meg színes sikerjelzéssel.

A pm könyvtár és a kérések láncolása

A pm objektum módszereket biztosít a válasszal való munkához: pm.response, pm.expect, pm.variables. A kérések láncolása úgy valósul meg, hogy az egyik kérés válaszából származó adatokat változóba mentjük, majd a következőben használjuk. Ez az integrációs tesztek felépítésének és az üzleti logika API-hívások sorozatával történő ellenőrzésének alapja.

// Teszt: a válasz szerkezetének ellenőrzése és a token mentése
pm.test("Status code is 200", () => {
    pm.response.to.have.status(200);
});

const json = pm.response.json();
pm.environment.set("auth_token", json.data.token);

Collection Runner és Newman

Collection Runner a kollekció összes kérését egymás után futtatja, minden lépésnél elvégezve a teszteket. A Newman a Postman konzolos változata CI/CD-pipeline-okhoz (Jenkins, GitHub Actions, GitLab CI). A Newman JSON, JUnit és HTML formátumokban exportálja a jelentést a monitoringrendszerekkel való integrációhoz.

Munka a GraphQL-lel és a WebSocketkel

A GraphQL kéréseket a Postmanben POST-on keresztül küldjük egyetlen endpointra, JSON formátumú törzzsel. A GraphQL (Beta) fül vizuális szerkesztőt biztosít szintaxiskiemeléssel, mezők automatikus kiegészítésével és sémával. A kérés változóit külön Variables panelen adjuk át.

WebSocket- és Socket.IO-tesztelés

Postman támogatja a WebSocket-kapcsolatokat egy külön felületen keresztül üzenetpanellel. Lehetőség van szöveges és bináris üzenetek küldésére, a kapcsolat előzményeinek megtekintésére és megszakadás esetén automatikus újracsatlakozásra. A Socket.IO kliens az Engine.IO protokollal kompatibilis módban működik.

// WebSocket-teszt a Postmanben a pm API-n keresztül
const ws = new WebSocket("wss://echo.websocket.org");
ws.onmessage = (event) => {
    pm.test("Echo response received", () => {
        pm.expect(event.data).to.eql("Hello");
    });
};

Mock-szerverek és monitoring a Postmanben

Mock-szerverek lehetővé teszik az API-endpointok emulálását a meglévő kollekciók alapján. Ez akkor hasznos, ha a backend még nincs kész, de a frontend vagy a mobilalkalmazás már fejlesztés alatt áll. A mock-szerver a kollekcióból ad vissza válaszpéldát helyes fejlécekkel és állapotkóddal.

Mock-szerver létrehozása

A mock-szerver egy kattintással jön létre a kollekcióból: válassza ki a kollekciót → Mock Servers → Add a new mock server. A Postman egyedi URL-t generál, amely a valódi API helyett használható az alkalmazás kódjában. A kollekció minden kérésére a mock a mentett Example Responseot adja vissza, ami lehetővé teszi a felhasználói felület ellenőrzését a backend befejezése előtt.

API-monitoring a Postman Monitors segítségével

Monitors ütemezés szerint futtatja a kollekciót (5 percenként, óránként vagy naponta), és ellenőrzi az API elérhetőségét és helyességét. Tesztbukás esetén a monitor e-mailben vagy Slacken küld értesítést. A monitoring a Postman felhőjéből működik, nem igényel külön szervert, és az ingyenes csomagon havonta akár 10 000 kérést is támogat.

// Monitoringteszt: a válaszidő ellenőrzése
pm.test("Response time < 2000ms", () => {
    pm.expect(pm.response.responseTime).to.be.below(2000);
});

pm.test("Content-Type is JSON", () => {
    pm.response.to.have.header("Content-Type");
});

Biztonság és titkok kezelése

Postman biztonságos mechanizmusokat biztosít az API-kulcsokkal való munkához. A Secret típusú változók titkosítva vannak, és nem jelennek meg a felületen. Csapatmunkához használjon Workspace-et az Admin, Editor és Viewer szerepkörökkel.

Változók titkosítása

Környezeti változó létrehozásakor válassza a Secret típust — az érték minden felületen csillagokkal rejtve marad. A titkok megosztáskor nem exportálódnak a kollekcióba, és nem jelennek meg a Newman naplóiban. A jelszavakat és tokeneket ajánlott kizárólag Secret változókban tárolni.

Integráció a Vaulttal

A Postman támogatja a HashiCorp Vault és az AWS Secrets Manager integrációját. A Pre-request szkriptek dinamikusan lekérhetik a titkokat a külső tárolóból, kizárva az érzékeny adatok tárolását a kollekció- és környezetfájlokban.

Biztonság és titkok kezelése

Postman biztonságos mechanizmusokat biztosít az API-kulcsokkal való munkához. A Secret típusú változók titkosítva vannak, és nem jelennek meg a felületen. Csapatmunkához használjon Workspace-et az Admin, Editor és Viewer szerepkörökkel.

Változók titkosítása

Környezeti változó létrehozásakor válassza a Secret típust — az érték minden felületen csillagokkal rejtve marad. A titkok megosztáskor nem exportálódnak a kollekcióba, és nem jelennek meg a Newman naplóiban. A jelszavakat és tokeneket ajánlott kizárólag Secret változókban tárolni.

Integráció a Vaulttal

A Postman támogatja a HashiCorp Vault és az AWS Secrets Manager integrációját. A Pre-request szkriptek dinamikusan lekérhetik a titkokat a külső tárolóból, kizárva az érzékeny adatok tárolását a kollekció- és környezetfájlokban.