Een REST-API testen in 5 minuten

Het doel: van een OpenAPI-specificatie naar een geautomatiseerde test die een volledig traject controleert.

1. De specificatie importeren (30 seconden)

Bestand ▸ Importeren (Ctrl+I), en daarna de URL van uw openapi.json.

Restorm bouwt de complete boom op: één map per label, één verzoek per operatie, de getypeerde parameters, de documentatie, en de authenticatieheaders al voorgeschakeld met hun variabelen.

De boom die de OpenAPI-import oplevert, direct klaar voor gebruik: één map per label (pet, store, user) en één voorgevuld verzoek per operatie, naast het starttabblad van de omgevingsmap

Heeft uw API geen specificatie, plak dan een curl-opdracht — zie cURL-opdrachten importeren.

2. De omgeving invullen (1 minuut)

Open de omgevingsmap die de import heeft aangemaakt. De basis-URL staat er al; vul de authenticatievariabele aan die de import voor u heeft klaargezet.

Maak een tweede omgeving als u meerdere doelen test — de kiezer in de smartbar schakelt de hele map in één keer om.

3. Een eerste aanroep versturen (30 seconden)

Open een verzoek en klik op Send. De respons verschijnt: status, tijd, headers, body in een uitvouwbare viewer.

Bent u iets vergeten, dan vertelt de opgeloste waarde onder het URL-veld u dat.

4. Het scenario bouwen (2 minuten)

Rechtsklik ▸ Toevoegen ▸ Scenario. Het traject “aanmaken, teruglezen, verwijderen”:

HTTP-verzoek “POST /clients”
     └─response──► Assert (eq, 201)
              └─► Variabele instellen “clientId”   ◄── selector body.id

HTTP-verzoek “GET /clients/{id}”
     └─response──► Assert (eq, 200)
              └─► Schema validate (het JSON Schema van de klant)

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

De drie verzoeken gebruiken {{clientId}} in hun URL: de runvariabele die in de eerste stap is gezet, wordt door de volgende stappen gelezen.

Knoop ze aan elkaar door de poort done van elke assertie op de poort in van het volgende verzoek te verbinden — dat garandeert de volgorde.

5. Controleren (30 seconden)

Klik op Uitvoeren. Het logboek vult zich; voeg na elke stap een actie Log toe om vast te leggen wat belangrijk is.

Sluit een actie Throw aan op de uitvoer else van uw kritieke asserties: dat is wat de CI-job zal laten mislukken.

6. Het automatiseren (30 seconden)

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

Afsluitcode 0 als alles slaagt, anders 1. Zie Headless uitvoering en CI voor de voorbeelden met GitHub Actions en GitLab CI.