Testaa REST-API viidessä minuutissa

Tavoite: lähteä liikkeelle OpenAPI-määrityksestä ja päätyä automatisoituun testiin, joka tarkistaa kokonaisen polun.

1. Määrityksen tuonti (30 sekuntia)

Tiedosto ▸ Tuo (Ctrl+I) ja sitten openapi.json-tiedostosi URL.

Restorm rakentaa koko puun: yksi kansio kutakin tunnistetta kohti, yksi pyyntö kutakin operaatiota kohti, tyypitetyt parametrit, dokumentaatio sekä valmiiksi kytketyt todennusotsakkeet muuttujineen.

OpenAPI-tuonnin tuottama, heti käyttövalmis puu: yksi kansio kutakin tunnistetta kohti (pet, store, user) ja yksi esitäytetty pyyntö kutakin operaatiota kohti, muuttujakansion aloitusvälilehden vieressä

Jos API:llasi ei ole määritystä, liitä curl-komento — katso cURL-komentojen tuonti.

2. Ympäristön täyttäminen (1 minuutti)

Avaa tuonnin luoma muuttujakansio. Perus-URL on jo paikallaan; täydennä todennusmuuttuja, jonka tuonti on valmistellut puolestasi.

Luo toinen ympäristö, jos testaat useita kohteita — smartbarin valitsin vaihtaa koko kansion kerralla.

3. Ensimmäisen kutsun lähettäminen (30 sekuntia)

Avaa pyyntö ja napsauta Send. Vastaus näkyy: tila, aika, otsakkeet ja sisältö taitettavassa katselimessa.

Jos jotain jäi unohtumaan, URL-kentän alla näkyvä ratkaistu arvo kertoo sen.

4. Skenaarion rakentaminen (2 minuuttia)

Hiiren oikea painike ▸ Lisää ▸ Skenaario. Polku ”luo, lue, poista”:

HTTP-pyyntö ”POST /clients”
     └─response──► Assert (eq, 201)
              └─► Aseta muuttuja ”clientId”   ◄── valitsin body.id

HTTP-pyyntö ”GET /clients/{id}”
     └─response──► Assert (eq, 200)
              └─► Schema validate (asiakkaan JSON Schema)

HTTP-pyyntö ”DELETE /clients/{id}”
     └─response──► Assert (eq, 204)

Kaikki kolme pyyntöä käyttävät URL-osoitteessaan muuttujaa {{clientId}}: ensimmäisessä vaiheessa asetetun suoritusmuuttujan lukevat seuraavat vaiheet.

Ketjuta ne kytkemällä kunkin väittämän portti done seuraavan pyynnön porttiin in — juuri se takaa järjestyksen.

5. Tarkistaminen (30 sekuntia)

Napsauta Toista. Loki täyttyy; lisää jokaisen vaiheen jälkeen toiminto Log jäljittääksesi sen, mikä on olennaista.

Kytke toiminto Throw kriittisten väittämiesi lähtöön else: juuri se kaataa CI-työn.

6. Automatisointi (30 sekuntia)

RESTORM_TOKEN=rstk_… restorm \
  --open ./api.restorm \
  --run "Parcours client" \
  --headless \
  --out run.log

Poistumiskoodi 0, jos kaikki menee läpi, muutoin 1. Katso Headless-suoritus ja jatkuva integraatio GitHub Actions- ja GitLab CI -esimerkkien osalta.