Importere OpenAPI / Swagger

Dette er den mest komplette importen i Restorm. Tre versjoner gjenkjennes: Swagger 2.0, OpenAPI 3.0 og OpenAPI 3.1.

Importere

Fil ▸ Importer (Ctrl+I), og deretter en swagger.json- eller openapi.json-fil, eller URL-en til spesifikasjonen direkte.

Hvis URL-en svarer med 401 eller 403, tilbyr Restorm å knytte til en autentisering og prøve igjen, uten at du må lukke importdialogen.

Hva som importeres

Element i spesifikasjonen	Hva Restorm gjør med det
servers (eller host + basePath + schemes)	Basis-URL-en til miljøet, med servervariabler løst opp
tags	Én mappe per etikett, pluss en Other-mappe for resten
Hver operasjon	En HTTP-forespørsel, med metode og sti
Parametere	Sti-, spørrings- og headerparametere, typede (streng, tall, dato-og-tid, enum, hemmelighet …)
requestBody	Kroppen, i sin innholdstype
examples	Kroppen forhåndsfylt med eksempelet som er oppgitt
components / definitions	API-dokumentasjonen: modeller, beskrivelser
enum	Enumerasjoner som kan gjenbrukes som verditype
Svar	Dokumentert per innholdstype

$ref løses opp, også på tvers av komponentene.

Linjen components / definitions fortjener en understrekning: importen begrenser seg ikke til forespørslene, den beholder hele API-dokumentasjonen — beskrivelser, modeller, sikkerhetsskjemaer, eksempler og enumerasjoner. Du finner den i fanen Docs i miljømappen som importen ga, og i fanen til hver enkelt forespørsel, og den synkroniseres på nytt fra kilden. Se Tilgang til og oppdatering av dokumentasjonen for et importert API.

Sikkerhet

Sikkerhetsskjemaene som er deklarert, oversettes til ferdigkoblede headere eller parametere, med den tilsvarende miljøvariabelen opprettet for deg:

Skjema	Hva Restorm setter opp
apiKey i header eller spørring	Et par navngitt etter skjemaet, med verdien {{<schema>}}
http + basic	Authorization: Basic {{<schema>_credentials}}
http + bearer, oauth2, openIdConnect	Authorization: Bearer {{<schema>_token}}

Da gjenstår bare å fylle inn variabelen — eller å bytte den ut med en autentiseringsrute for å få automatisk fornyelse.

Kjente begrensninger

apiKey som sendes via cookie, blir ikke ferdigkoblet (OpenAPI 3). Et sikkerhetsskjema som er referert, men ikke deklarert, ignoreres stille.

Oppdatere

OpenAPI og Swagger er blant formatene som kan synkroniseres på nytt: knappen Oppdater på mappen henter kilden, og Restorm bruker deltaet — nye operasjoner legges til, operasjoner som er forsvunnet, merkes utdatert istedenfor å bli slettet, og endringene dine beholdes. Se Oppdatere fra kilden.