Aller au contenu
Restorm Dokumentacioni i Restorm

Zbulimi i problemeve në një API të importuar

Kur importoni një API (OpenAPI, Swagger dhe formatet e tjera të mbështetura), Restorm e ruan dokumentacionin e strukturuar të API-së në dosjen e variablave të saj. Menjëherë pas importimit — dhe sa herë që rihapni skedarin — Restorm e projekton në heshtje atë dokumentacion në një dizajn dhe ekzekuton të njëjtin validim që zbaton dizajnuesi i API-ve, tërësisht në sfond. Ai nuk e bllokon kurrë importimin dhe nuk prek kurrë atë që po bëni.

Nëse nuk gjen asgjë, nuk shihni asgjë. Nëse gjen probleme strukturore, jua tregon në dy vende.

«!»-i në shiritin anësor

Section titled “«!»-i në shiritin anësor”

Dosja e variablave që mban API-në e sinjalizuar shfaq një «!» të vogël në të djathtë të rreshtit të saj. Është sinjali me një shikim se dizajni i kësaj API-je ka diçka që meriton vëmendje — dhe zhduket vetvetiu sapo API-ja bëhet përsëri e pastër (pas një riimportimi ose një përditësimi të API-së që e ndreq atë).

Skeda «Probleme»

Section titled “Skeda «Probleme»”

Hapni dosjen e variablave dhe asaj i shtohet një skedë Probleme. Skeda shfaqet vetëm kur janë zbuluar probleme — një API e pastër nuk e shfaq kurrë atë.

Skeda Probleme e dosjes së variablave të një API-je të importuar: një kuti paralajmërimi, pastaj problemet e grupuara sipas llojit — «Disa rrugë i përgjigjen të njëjtës metodë dhe të njëjtit shteg», «Disa rrugë nuk deklarojnë asnjë përgjigje», «Disa rrugë ndodhen në një shteg që serveri i dizajnit e rezervon» — secila duke renditur rrugët e sakta që prek, njëra e zgjeruar për të treguar dokumentacionin e asaj rruge

Problemet grupohen sipas llojit, kështu që njëzet rrugë të dyfishta shfaqen si një rresht i vetëm me një numërues në vend të njëzet zërave të veçantë. Nën çdo lloj, Restorm rendit entitetet e sakta të prekura — një rrugë tregon foljen e saj HTTP dhe shtegun e vërtetë dhe zgjerohet te dokumentacioni i asaj rruge që të mund të shihni çfarë deklaron pa e lënë skedën.

Kontrollet pasqyrojnë ato të dizajnuesit të API-ve, kështu që llojet e problemeve që mund të shihni përfshijnë:

  • rrugë të dyfishta — dy rrugë që i përgjigjen të njëjtës metodë dhe të njëjtit shteg;
  • përgjigje që mungojnë — një rrugë që nuk deklaron asnjë përgjigje fare;
  • shtigje të rezervuara — një rrugë që ndodhet në një shteg që Mock Server e rezervon (/swagger.json, /graphql, …), i cili nuk do të përgjigjej kurrë;
  • probleme kufizimi — një model i pavlefshëm ose një minimum më i madh se maksimumi i tij.

Lista është vetëm për lexim: ju tregon çfarë të ndreqni, dhe ju e ndreqni te burimi (riimportoni një specifikim të korrigjuar ose modifikoni API-në). Ajo rillogaritet në ngjarjet që ndryshojnë një API — hapja e një skedari, një importim, një përditësim i API-së — jo në çdo shtypje tasti.