Importarea OpenAPI / Swagger
Este cel mai complet import din Restorm. Sunt recunoscute trei versiuni: Swagger 2.0, OpenAPI 3.0 și OpenAPI 3.1.
Importarea
Section titled “Importarea”Fișier ▸ Importă (Ctrl+I), apoi un fișier swagger.json /
openapi.json sau direct URL-ul specificației.
Dacă URL-ul răspunde cu 401 sau 403, Restorm vă propune să atașați o
autentificare și să reîncercați, fără să părăsiți fereastra modală de import.
Ce se importă
Section titled “Ce se importă”| Element din specificație | Ce face Restorm cu el |
|---|---|
servers (sau host + basePath + schemes) | URL-ul de bază al mediului, cu variabilele de server rezolvate |
tags | Un folder pentru fiecare etichetă, plus un folder Other pentru rest |
| Fiecare operație | O cerere HTTP, inclusiv metoda și calea |
| Parametri | Parametri de cale, de interogare și antete, tipizați (șir, număr, dată-oră, enumerare, secret…) |
requestBody | Corpul, în tipul său de conținut |
examples | Corpul precompletat cu exemplul furnizat |
components / definitions | Documentația de API: modele, descrieri |
enum | Enumerări reutilizabile ca tip de valoare |
| Răspunsuri | Documentate pe tipuri de conținut |
Referințele $ref sunt rezolvate, inclusiv prin componente.
Rândul components / definitions merită subliniat: importul nu se limitează la
cereri, ci păstrează toată documentația API-ului — descrieri, modele, scheme
de securitate, exemple, enumerări. Ea este consultabilă în fila Docs a
folderului de variabile provenit din import, ca și în cea a fiecărei cereri, și se
re-sincronizează din sursă. Vedeți
Accesul și actualizarea documentației unui API importat.
Securitate
Section titled “Securitate”Schemele de securitate declarate sunt traduse în antete sau parametri precablați, cu variabila de mediu corespunzătoare creată pentru dumneavoastră:
| Schemă | Ce pune Restorm |
|---|---|
apiKey în antet sau în interogare | O pereche numită după schemă, valoare {{<schema>}} |
http + basic | Authorization: Basic {{<schema>_credentials}} |
http + bearer, oauth2, openIdConnect | Authorization: Bearer {{<schema>_token}} |
Nu mai rămâne decât să completați variabila — sau să o înlocuiți cu o rută de autentificare, pentru a beneficia de reînnoirea automată.
Actualizarea
Section titled “Actualizarea”OpenAPI și Swagger se numără printre formatele re-sincronizabile: butonul Actualizează al folderului recuperează sursa, iar Restorm aplică delta — operațiile noi sunt adăugate, operațiile dispărute sunt marcate depreciate în loc să fie șterse, iar modificările dumneavoastră sunt păstrate. Vedeți Actualizarea din sursă.