API-tesztelés a gyakorlatban: REST, SOAP és a Dynamics 365 Web API
Röviden: az API-teszt a felület alatt, közvetlenül a szolgáltatás hívásával ellenőrzi az üzleti logikát és az integrációkat. Gyorsabb és stabilabb, mint a felületi teszt, és akkor is futtatható, amikor a felület még nincs kész. A Dynamics 365 adatrétege, a Dataverse OData v4-alapú REST API-t ad Microsoft Entra ID-s hitelesítéssel; erre Tricentis Tosca API Scannel, Playwrighttal vagy Postmannel építünk teszteket, és minden telepítés előtt lefuttatjuk őket a CI-ben.
Mi az API-tesztelés, és miben más, mint a felületi teszt?
Az API (alkalmazásprogramozási felület) az a szerződés, amelyen két rendszer egymással beszél: milyen kérést lehet küldeni, és milyen választ kell kapni rá. Az API-teszt ezt a szerződést ellenőrzi: elküld egy kérést, majd megnézi a státuszkódot, a válasz szerkezetét és tartalmát, a fejléceket, a válaszidőt, és ha a hívás adatot írt, azt is, hogy a rendszerben valóban az került-e rögzítésre.
A felületi teszt ettől nem felesleges: a felhasználói folyamatot végponttól végpontig csak az látja. A jó arány a tesztpiramis szerint sok API-teszt és kevesebb, gondosan kiválasztott felületi teszt — erről a manuális vagy automatizált tesztelés cikkben írtunk részletesen.
REST vagy SOAP: mi a különbség tesztelés szempontjából?
A két leggyakoribb API-stílus másképp írja le a szerződést, és másképp jelzi a hibát; a teszteszköznek mindkettőt értenie kell, ha egy folyamat mindkettőn átmegy.
| Szempont | REST | SOAP |
|---|---|---|
| Üzenet | jellemzően JSON; az erőforrást az URL azonosítja, a műveletet a HTTP-ige (GET, POST, PATCH, DELETE) | XML-boríték (envelope) egy végponton; a műveletet az üzenet neve adja |
| Szerződés | OpenAPI/Swagger; OData-szolgáltatásnál a $metadata dokumentum | WSDL és XSD |
| Hibajelzés | HTTP-státuszkód (4xx, 5xx) és hibaüzenet a válasz törzsében | SOAP Fault elem, HTTP-n 500-as státusszal |
| Mit ellenőrzünk | státuszkód, JSON-séma, mezőértékek, fejlécek, válaszidő | séma szerinti XML, mezőértékek XPath-szal, Fault-kódok |
| Hol találkozunk vele | modern webes és felhőszolgáltatások, a Dataverse Web API | régebbi vállalati rendszerek: ERP, banki és logisztikai integrációk |
A tesztelés logikája mindkettőnél ugyanaz: érvényes kérés, helyes válasz (pozitív eset), hibás kérés, értelmes hibaüzenet (negatív eset), és mellékhatás: a rekord valóban létrejött, a státusz valóban átváltott, a kapcsolódó rendszer valóban megkapta az adatot.
Hogyan működik a Dynamics 365 (Dataverse) Web API?
A Dynamics 365 CRM-alkalmazások (Sales, Customer Service és a többi) adatai a Dataverse-ben vannak. A Microsoft Learn szerint a Dataverse Web API az OData 4.0 protokollt valósítja meg, vagyis szabványos REST API: a táblák és oszlopok leírását a $metadata dokumentum adja, a rekordokat GET, POST, PATCH és DELETE kérésekkel lehet olvasni, létrehozni, módosítani és törölni.
Mit érdemes API-szinten tesztelni egy Dynamics 365-rendszerben?
- Plug-in- és szabálylogika: rekord létrehozása vagy módosítása API-n, majd a számított mezők, a státuszváltás és a létrejött kapcsolódó rekordok visszaolvasása.
- Jogosultságok: ugyanaz a kérés különböző biztonsági szerepkörű tesztfelhasználókkal; amit egy szerepkör nem láthat vagy nem módosíthat, azt a rendszernek el kell utasítania.
- Integrációk: az ERP-be, számlázásba vagy webshopba menő adat mezőről mezőre, a fogadó oldal API-jával összevetve.
- Egyéni API-k és műveletek: a saját fejlesztésű végpontok bemenete, kimenete és hibaágai.
- Hibakezelés: hiányzó kötelező mező, érvénytelen keresőmező-hivatkozás, túl hosszú szöveg — a válasz legyen egyértelmű, a rendszer pedig ne maradjon félkész állapotban.
Az API-teszt saját tesztadattal dolgozik: a szükséges rekordokat a teszt elején létrehozza, a végén törli, és soha nem éles környezetben fut. Hogy ehhez honnan jön GDPR-kompatibilis adat, azt a tesztadat-kezelés Dynamics 365-tesztekhez cikkben írtuk le.
Melyik eszközzel: Tricentis Tosca API Scan, Playwright vagy Postman?
A választás a csapaton múlik, nem az API-n: ha a teszteket üzleti tesztelők is karbantartják, a Tosca; ha fejlesztők, a Playwright; feltáró és integrációs ellenőrzéshez a Postman. Az eszközök általános összevetése: Tricentis Tosca, Katalon vagy Playwright?
Hogyan fut az API-teszt CI/CD-ben?
Az API-tesztek ugyanabba a telepítési folyamatba kerülnek, mint a felületi tesztek: minden telepítés előtt és éjszakánként lefutnak a tesztkörnyezet ellen, az eredmény JUnit-formátumú jelentésként a folyamat mellé kerül, és hibánál megállítják a telepítést. A hozzáférési adatokat (kliensazonosító, titok vagy tanúsítvány) a CI titoktárolója adja, a repóba nem kerülnek.
Dynamics 365-nél az API-tesztek különösen a félévenkénti frissítés előtt hasznosak: az integrációk hibája a felületen nem látszik, API-szinten viszont azonnal kiderül. Erről szól a Dynamics 365 tesztautomatizálás és release wave cikk.
Hogyan segítünk az API-tesztelésben?
Felmérjük az integrációkat és a saját fejlesztésű logikát, kockázat szerint kiválasztjuk az API-szinten tesztelendő eseteket, felépítjük a tesztkészletet a csapatához illő eszközzel, bekötjük a CI-be, és a rendszerrel együtt karbantartjuk.
Részletek a szolgáltatásról: tesztautomatizálás és tesztelés.
Gyakori kérdések
Mi a különbség az API-teszt és az integrációs teszt között?
Az API-teszt egy szolgáltatás szerződését ellenőrzi: adott kérésre a helyes válasz jön-e. Az integrációs teszt azt nézi, hogy két vagy több rendszer együtt helyesen működik-e. A gyakorlatban az integrációs teszt nagy része API-hívásokból áll.
Kell programozni az API-teszteléshez?
Nem feltétlenül. A Tricentis Tosca API Scan kód nélkül építi a teszteket a szolgáltatásleírásból; Postmanben kevés szkripttel lehet ellenőrzéseket írni. A Playwright kódalapú, fejlesztőknek való.
Lehet SOAP-szolgáltatást Playwrighttal tesztelni?
Igen, mert a Playwright bármilyen HTTP-kérést el tud küldeni, így egy SOAP-boríték is mehet XML-törzsként. WSDL-támogatás viszont nincs benne, az XML-választ a tesztnek kell feldolgoznia. Sok SOAP-szolgáltatásnál ezért a Tosca vagy a Postman kényelmesebb.
Hogyan hitelesít a teszt a Dynamics 365 Web API-hoz?
OAuth 2.0 tokennel a Microsoft Entra ID-ból. Automatizált teszthez alkalmazásregisztráció és a Dynamics-környezetben felvett alkalmazásfelhasználó kell, a tesztnek megfelelő biztonsági szerepkörrel; a titkot vagy tanúsítványt a CI titoktárolója adja.
Futtathatók az API-tesztek éles környezetben?
Írási teszteket nem futtatunk élesben: rekordot hoznának létre, plug-ineket és folyamatokat indítanának el. A tesztek sandboxban futnak; élesben legfeljebb csak olvasó, adatot nem módosító ellenőrzés jöhet szóba, egyeztetve.
Beszéljünk a projektjéről.
Vegye fel velünk a kapcsolatot, és néhány napon belül jelentkezünk Önnél!
Kapcsolatfelvétel