OpenAPI / Swagger importálása
Ez a Restorm legteljesebb importálása. Három verzió felismert: Swagger 2.0, OpenAPI 3.0 és OpenAPI 3.1.
Importálás
Section titled “Importálás”Fájl ▸ Importálás (Ctrl+I), majd egy swagger.json / openapi.json
fájl, vagy közvetlenül a specifikáció URL-je.
Ha az URL 401 vagy 403 választ ad, a Restorm felajánlja hitelesítés
csatolását és az újbóli próbálkozást, az importálási párbeszédpanel elhagyása
nélkül.
Az importált elemek
Section titled “Az importált elemek”| A specifikáció eleme | Amit a Restorm készít belőle |
|---|---|
servers (vagy host + basePath + schemes) | A környezet alap-URL-je, feloldott kiszolgálóváltozókkal |
tags | Címkénként egy mappa, a többinek pedig egy Other mappa |
| Minden művelet | Egy HTTP-kérés, a metódussal és az útvonallal együtt |
| Paraméterek | Útvonal-, lekérdezési és fejlécparaméterek, típusosan (karakterlánc, szám, dátum-idő, felsorolás, titok…) |
requestBody | A törzs, a saját tartalomtípusában |
examples | A megadott példával előre kitöltött törzs |
components / definitions | Az API-dokumentáció: modellek, leírások |
enum | Értéktípusként újra felhasználható felsorolások |
| Válaszok | Tartalomtípus szerint dokumentálva |
A $ref hivatkozások feloldódnak, a komponenseken keresztül is.
A components / definitions sort érdemes kiemelni: az importálás nem áll meg a
kéréseknél, hanem az API teljes dokumentációját megőrzi — leírásokat,
modelleket, biztonsági sémákat, példákat, felsorolásokat. Ez az importálásból
származó környezeti mappa Dokumentáció lapján éppúgy megtekinthető, mint
minden egyes kérésén, és a forrásból újraszinkronizálható. Lásd:
Importált API dokumentációjának elérése és frissítése.
Biztonság
Section titled “Biztonság”A deklarált biztonsági sémákból előre bekötött fejlécek vagy paraméterek lesznek, a hozzájuk tartozó környezeti változóval együtt:
| Séma | Amit a Restorm létrehoz |
|---|---|
apiKey fejlécben vagy lekérdezésben | Egy a sémáról elnevezett pár, {{<schema>}} értékkel |
http + basic | Authorization: Basic {{<schema>_credentials}} |
http + bearer, oauth2, openIdConnect | Authorization: Bearer {{<schema>_token}} |
Már csak a változót kell kitölteni — vagy egy hitelesítési útvonalra cserélni, hogy az automatikus megújítás is működjön.
Frissítés
Section titled “Frissítés”Az OpenAPI és a Swagger az újraszinkronizálható formátumok közé tartozik: a mappa Frissítés gombja letölti a forrást, a Restorm pedig alkalmazza a különbséget — az új műveletek bekerülnek, az eltűnt műveletek törlés helyett elavultként megjelölve maradnak, a saját módosítások pedig megmaradnak. Lásd: Frissítés a forrásból.