API:n testaus Postmanilla

Katsotaan ensin, mitä Postmanin tekijät itse sanovat:

»Postman on voimakas joukko API:n testausvälineitä, joista moni kehittäjä ei enää tule toimeen ilman. Teemme mainioita tuotteita, jotka auttavat luomaan vaikuttavia rajapintoja ja työskentelemään tuottavammin. Postmania käyttää yli miljoona kehittäjää maailmassa, ja määrä kasvaa jatkuvasti. Aiomme kehittää muitakin tuotteita antaaksemme kehittäjille vahvimman ratkaisun API:en luomiseen ja testaamiseen.»

Postmanin nykyinen versio on vanhoja vahvempi, ja moni Pro-ominaisuus on nyt saatavilla maksutta. Enemmänkin: tätä välinettä ei tehty vain kehittäjille. Edes automaattisten vastausten koettelu ei vaadi erityistä osaamista. Se on hyvin yksinkertainen ja samalla voimakas väline.

Pyynnön lähettäminen

Jos avaatte tämän joukon, siirrytte kohtaan »Request Methods» ja sitten kohtaan »GET Requests», kaikki tallennetut tiedot ilmestyvät Postman-ikkunan keskiosaan. Painakaa nyt »Submit». Lähetitte juuri ensimmäisen pyyntönne ja saitte ensimmäisen vastauksen.

POST-pyynnöt ovat hieman hankalampia, mutta yhtä selviä ja johdonmukaisia. Tällä kertaa käytätte omaa pyyntöä. Painakaa plusmerkkiä avataksenne uuden välilehden, vaihtakaa pyynnön tyypiksi GET:n sijaan POST ja antakaa https://jsonplaceholder.typicode.com/posts pyynnön osoitteeksi. Se on maksuton REST-palvelu, jota voi käyttää keksityille tiedoille. Se on hyvin hyödyllinen oppimiseen, palvelimen toiminnan jäljittelyyn ja koodiesimerkkien jakamiseen.

Nyt tarvitaan POST-pyynnön runko. Painakaa osoitteen alta »Body», vaihtakaa tyypiksi »raw» ja »Text» tilalle »JSON». Liittäkää sitten editoriin tämä kysely: 

1. {
2. “title”: “My first POST request”,
3. “body”: “Content of my first POST request!”,
4. “userId”: 789
5. }

Painakaa »send». Teidän pitäisi saada vastaus omalla tekstillänne — vahvistus siitä, että pyyntö onnistui. Tallentakaa se tulevaa varten. Voitte myös luoda uuden kokoelman: painakaa vain »Save» osoitteen oikealla puolella. Avautuu tallennusikkuna, jossa pyynnölle voi antaa nimen ja luoda sille uuden kokoelman.

Tarkistukset

Toinen Postmanin hieno ominaisuus ovat pyyntöjen automaattiset tarkistukset. Kun kerran luotte tarkistuksen pyynnölle, Postman koettelee jokaisen saapuvan vastauksen tapaustenne mukaan. Katsotaan yksinkertainen esimerkki.

Lisätkää uusi oma pyyntö hakeaksenne POSTin osoitteesta https://jsonplaceholder.typicode.com/posts tunnuksella ID = 6 ja avatkaa välilehti »Tests». Postman-ikkunan oikeassa laidassa näette luettelon katkelmia. Se auttaa kirjoittamaan ensimmäisen tarkistuksen, toisen ja kaikki seuraavat, sillä tuo koodi sopii mihin tahansa — sitä tarvitsee vain hieman sovittaa omiin tarpeisiin.

tests[“Status code is 200”] = responseCode.code === 200;

1. var jsonData = JSON.parse(responseBody);
2. tests[“User ID is 1”] = jsonData.userId === 1;
3. tests[“Post ID is 6”] = jsonData.id === 6;
4. tests[“Body matches string”] = responseBody.has(“dolorem eum magni eos aperiam quia”);
5. Ensimmäisessä tarkistuksessa katsomme, palauttaako vastaus pyyntöömme HTTP-tilan »200», onko käyttäjän tunnus 1 ja kirjoituksen tunnus 6, ja sisältääkö vastauksen runko odotetun tekstin.

Painakaa nyt vain »Submit». Kun vastaus on tullut, avatkaa välilehti »Tests» ja tarkistakaa, menivätkö kaikki läpi.

Tällä artikkelilla halusimme näyttää, miten yksinkertaista ja mukavaa Postmanin kanssa on työskennellä!