Tutvus Postmaniga: kes veel võib olla klient

Saad teada, mis on API ja endpoint ning miks ei ole klient ainult brauser. Tutvud Postmaniga kui testija töövahendiga, õpid eristama path- ja query-parameetreid ning tundma Postmani peamisi tööalasid.

Tootest

Alex, QA tiimijuht

Tere! On uus ülesanne. Meeskond teeb BB Foodi kataloogi ümber: uue API-ga server on valmis, kuid kataloogilehte frontend-arendajad alles teevad. API on vaja kohe ära kontrollida.

Lühiviide

API

Reeglid, mille järgi programmid suhtlevad: milliseid päringuid server mõistab ja mida ta neile vastab. Nagu poelett koos hinnakirjaga: ostja küsib kaupa hinnakirja järgi ega lähe lattu, klient pöördub API poole ega lähe andmebaasi.

Endpoint

API üks konkreetne punkt: meetod koos teega, näiteks GET /api/v1/products. Täisaadress on baasaadress (base URL) pluss tee. Sama tee eri meetoditega on erinevad endpointid. Kõik need on kirjeldatud API dokumentatsioonis, sageli Swaggeris, mis genereeritakse tavaliselt automaatselt backendi koodist.

Kes võib olla klient

Klient on iga programm, mis saadab serverile päringu: brauser, mobiilirakendus või Postman. Server näeb ainult päringut ja vastab ühesugustele päringutele ühtemoodi.

Postman

Programm API-le päringute käsitsi saatmiseks. Näitab vastust nii, nagu see on: olekukood, aeg, suurus, päised ja keha. Brauser seevastu joonistab vastusest lehe.

Milleks testija liidesest mööda läheb

Et kontrollida API-t enne, kui leht on valmis; mõista, kus viga on — kliendis või serveris; saata andmeid, mida vorm läbi ei lase; korrata kontrolle kiiremini.

Path- ja query-parameetrid

Path-parameeter on tee osa ja valib konkreetse ressursi: /api/v1/products/5. Query-parameetrid tulevad pärast ?-märki võti=väärtus paaridena, eraldatud &-ga, ja täpsustavad päringut: /api/v1/products?category=bread&sort=price.

Postmani aken

Päringurida (meetod, aadress, Send), vahelehed Params, Authorization, Headers, Body ja Scripts ning vastuse paneel. Vasakul on kollektsioonid, keskkonnad ja ajalugu.

Kollektsioonid ja keskkonnad

Kollektsioon on kaustadesse salvestatud päringud, mida saab meeskonnaga jagada. Keskkond hoiab muutujaid, näiteks {{baseUrl}}: vahetasid keskkonda — päringud läksid teise serverisse.