Aller au contenu

Uvoz OpenAPI / Swagger

To je najkompletniji uvoz u Restormu. Prepoznaju se tri verzije: Swagger 2.0, OpenAPI 3.0 i OpenAPI 3.1.

Datoteka ▸ Uvezi (Ctrl+I), pa datoteka swagger.json / openapi.json, ili direktno URL specifikacije.

Ako URL odgovori sa 401 ili 403, Restorm vam predlaže da prikačite autentifikaciju i pokušate ponovo, bez napuštanja modalnog prozora za uvoz.

Stablo koje proizvodi OpenAPI uvoz u bočnom panelu — po jedna fascikla za svaku etiketu (pet, store, user) — pored početne podkartice fascikle promenljivih

Element specifikacijeŠta Restorm od toga pravi
servers (ili host + basePath + schemes)Osnovni URL okruženja, sa razrešenim promenljivama servera
tagsPo jedna fascikla za svaku etiketu, plus fascikla Other za ostatak
Svaka operacijaHTTP zahtev, uključujući metodu i putanju
ParametriParametri putanje, upita i zaglavlja, tipizovani (niska, broj, datum-vreme, enumeracija, tajna…)
requestBodyTelo, u svom tipu sadržaja
examplesTelo unapred popunjeno dostavljenim primerom
components / definitionsAPI dokumentacija: modeli, opisi
enumEnumeracije upotrebljive kao tip vrednosti
OdgovoriDokumentovani po tipu sadržaja

$ref se razrešavaju, uključujući i kroz komponente.

Red components / definitions zaslužuje da bude podvučen: uvoz se ne ograničava na zahteve, on čuva celu dokumentaciju API-ja — opise, modele, bezbednosne šeme, primere, enumeracije. Ona se može pregledati u kartici Docs fascikle promenljivih proistekle iz uvoza, kao i u kartici svakog zahteva, i ponovo se sinhronizuje iz izvora. Vidite Pristup dokumentaciji uvezenog API-ja i njeno ažuriranje.

Kartica Docs fascikle promenljivih proistekle iz uvoza, sa dokumentacijom API-ja i njenim sadržajem

Deklarisane bezbednosne šeme prevode se u unapred povezana zaglavlja ili parametre, uz odgovarajuću promenljivu okruženja napravljenu umesto vas:

ŠemaŠta Restorm postavlja
apiKey u zaglavlju ili u upituPar imenovan po šemi, vrednost {{<schema>}}
http + basicAuthorization: Basic {{<schema>_credentials}}
http + bearer, oauth2, openIdConnectAuthorization: Bearer {{<schema>_token}}

Ostaje samo da popunite promenljivu — ili da je zamenite rutom autentifikacije da biste dobili automatsko obnavljanje.

OpenAPI i Swagger spadaju u formate pogodne za ponovnu sinhronizaciju: dugme Osveži na fascikli preuzima izvor, a Restorm primenjuje deltu — nove operacije se dodaju, nestale operacije označavaju se kao zastarele umesto da budu obrisane, a vaše izmene se čuvaju. Vidite Ažuriranje iz izvora.