Aller au contenu

Testimi i një API-je REST në 5 minuta

Objektivi: të nisemi nga një specifikim OpenAPI dhe të mbërrijmë te një test i automatizuar që verifikon një rrugë të plotë.

Skedar ▸ Importo (Ctrl+I), pastaj URL-ja e openapi.json tuaj.

Restorm ndërton pemën e plotë: një dosje për çdo etiketë, një kërkesë për çdo veprim, parametrat e tipizuar, dokumentacionin dhe kokat e vërtetimit të parangjitura bashkë me variablat e tyre.

Pema e prodhuar nga importimi OpenAPI, gati për përdorim: një dosje për çdo etiketë (pet, store, user) dhe një kërkesë e paraplotësuar për çdo veprim, pranë nënskedës së mirëseardhjes së dosjes së variablave

Nëse API-ja juaj nuk ka specifikim, ngjitni një komandë curl — shihni Importimin e komandave cURL.

Hapni dosjen e variablave të krijuar nga importimi. URL-ja bazë është tashmë aty; plotësoni variablën e vërtetimit që importimi ka përgatitur për ju.

Krijoni një mjedis të dytë nëse testoni disa caqe — zgjedhësi i smartbar-it e kalon të gjithë dosjen njëherësh.

Hapni një kërkesë, klikoni Send. Përgjigjja shfaqet: status, kohë, koka, trup brenda një shikuesi të palosshëm.

Nëse keni harruar diçka, vlera e zgjidhur e shfaqur nën fushën e URL-së jua tregon.

Klik me të djathtën ▸ Shto ▸ Skenar. Rruga «krijo, rilexo, fshi»:

Kërkesë HTTP «POST /clients»
└─response──► Assert (eq, 201)
└─► Përcakto variablën «clientId» ◄── zgjedhësi body.id
Kërkesë HTTP «GET /clients/{id}»
└─response──► Assert (eq, 200)
└─► Validim skeme (JSON Schema e klientit)
Kërkesë HTTP «DELETE /clients/{id}»
└─response──► Assert (eq, 204)

Të tria kërkesat përdorin {{clientId}} brenda URL-së së tyre: variabla e ekzekutimit e vendosur në hapin e parë lexohet nga ato pasuese.

Zinxhirojini duke kabllëzuar portën done të çdo pohimi mbi portën in të kërkesës pasuese — kjo është ajo që garanton rendin.

Klikoni Luaj. Regjistri mbushet; shtoni një veprim Log pas çdo hapi për të gjurmuar atë që ka rëndësi.

Lidhni një veprim Throw me daljen else të pohimeve tuaja kritike: kjo është ajo që do ta bëjë punën e CI-së të dështojë.

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

Kod dalje 0 nëse gjithçka kalon, 1 përndryshe. Shihni Ekzekutimin headless dhe CI për shembujt GitHub Actions dhe GitLab CI.