Aller au contenu

Uvoz OpenAPI-ja / Swaggera

To je najpotpuniji Restormov uvoz. Prepoznaju se tri verzije: Swagger 2.0, OpenAPI 3.0 i OpenAPI 3.1.

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

Ako URL odgovori s 401 ili 403, Restorm vam predlaže da pridružite autentifikaciju i pokušate ponovno, bez napuštanja modalnog prozora za uvoz.

Stablo koje je u bočnom oknu proizveo OpenAPI uvoz — po jedna mapa za svaku etiketu (pet, store, user) — uz početnu podkarticu mape okruženja

Element specifikacijeŠto Restorm od toga radi
servers (ili host + basePath + schemes)Osnovni URL okruženja, s razriješenim varijablama poslužitelja
tagsPo jedna mapa za svaku etiketu, plus mapa Other za ostatak
Svaka operacijaHTTP zahtjev, uključujući metodu i putanju
ParametriParametri putanje, upita i zaglavlja, tipizirani (niz, broj, datum i vrijeme, enumeracija, tajna…)
requestBodyTijelo, u svojem tipu sadržaja
examplesTijelo unaprijed popunjeno danim primjerom
components / definitionsAPI dokumentacija: modeli, opisi
enumEnumeracije upotrebljive kao tip vrijednosti
OdgovoriDokumentirani po tipu sadržaja

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

Redak components / definitions zaslužuje isticanje: uvoz se ne ograničava na zahtjeve, nego čuva cjelokupnu dokumentaciju API-ja — opise, modele, sigurnosne sheme, primjere, enumeracije. Dostupna je u kartici Docs mape okruženja proizašle iz uvoza, kao i u kartici svakog zahtjeva, a ponovno se sinkronizira iz izvora. Pogledajte Pristup dokumentaciji uvezenog API-ja i njezino ažuriranje.

Kartica Docs mape okruženja proizašle iz uvoza, s dokumentacijom API-ja i njezinim sadržajem

Deklarirane se sigurnosne sheme prevode u unaprijed ožičena zaglavlja ili parametre, uz odgovarajuću varijablu okruženja stvorenu umjesto vas:

ShemaŠto Restorm postavlja
apiKey u zaglavlju ili upituPar nazvan po shemi, vrijednost {{<schema>}}
http + basicAuthorization: Basic {{<schema>_credentials}}
http + bearer, oauth2, openIdConnectAuthorization: Bearer {{<schema>_token}}

Ostaje samo popuniti varijablu — ili je zamijeniti rutom autentifikacije kako biste dobili automatsku obnovu.

OpenAPI i Swagger među formatima su koji se mogu ponovno sinkronizirati: gumb Osvježi u mapi dohvaća izvor, a Restorm primjenjuje razliku — nove se operacije dodaju, nestale se operacije označavaju zastarjelima umjesto da se brišu, a vaše se izmjene čuvaju. Pogledajte Ažuriranje iz izvora.