Importera OpenAPI / Swagger

Det här är Restorms mest kompletta import. Tre versioner känns igen: Swagger 2.0, OpenAPI 3.0 och OpenAPI 3.1.

Importera

Arkiv ▸ Importera (Ctrl+I), och sedan en swagger.json- eller openapi.json-fil, eller direkt URL:en till specifikationen.

Om URL:en svarar 401 eller 403 erbjuder Restorm dig att koppla på en autentisering och försöka igen, utan att du lämnar importdialogen.

Trädet som skapas av en OpenAPI-import i sidopanelen — en mapp per tagg (pet, store, user) — vid sidan av variabelmappens startunderflik

Vad som importeras

Element i specifikationen	Vad Restorm gör av det
`servers` (eller `host` + `basePath` + `schemes`)	Miljöns bas-URL, med servervariablerna upplösta
`tags`	En mapp per tagg, plus en mapp Other för resten
Varje operation	En HTTP-begäran, inklusive metod och sökväg
Parametrar	Sökvägs-, fråge- och headerparametrar, typade (sträng, tal, datum-tid, uppräkning, hemlighet …)
`requestBody`	Kroppen, i sin innehållstyp
`examples`	Kroppen förifylld med det exempel som anges
`components` / `definitions`	API-dokumentationen: modeller, beskrivningar
`enum`	Uppräkningar som kan återanvändas som värdetyp
Svar	Dokumenterade per innehållstyp

$ref löses upp, även genom komponenterna.

Raden components / definitions är värd att lyfta fram: importen stannar inte vid begärandena, den bevarar hela API:ets dokumentation — beskrivningar, modeller, säkerhetsscheman, exempel, uppräkningar. Den går att läsa i fliken Docs i den variabelmapp som importen skapar, liksom i varje begärans egen flik, och den synkroniseras om från källan. Se Läsa och uppdatera dokumentationen för ett importerat API.

Fliken Docs i variabelmappen som importen skapar, med API dokumentation och dess innehållsöversikt

Säkerhet

De deklarerade säkerhetsschemana översätts till färdigkopplade headers eller parametrar, med motsvarande miljövariabel skapad åt dig:

Schema	Vad Restorm lägger in
`apiKey` i en header eller i frågan	Ett par namngivet efter schemat, med värdet `{{<schema>}}`
`http` + `basic`	`Authorization: Basic {{<schema>_credentials}}`
`http` + `bearer`, `oauth2`, `openIdConnect`	`Authorization: Bearer {{<schema>_token}}`

Sedan återstår bara att fylla i variabeln — eller att byta ut den mot en autentiseringsväg för att få automatisk förnyelse.

Uppdatera

OpenAPI och Swagger hör till de format som går att synkronisera om: mappens knapp Uppdatera hämtar källan och Restorm tillämpar deltat — nya operationer läggs till, försvunna operationer märks som utfasade i stället för att tas bort, och dina ändringar behålls. Se Uppdatera från källan.