Importér OpenAPI / Swagger

Det er Restorms mest fuldstændige import. Tre versioner genkendes: Swagger 2.0, OpenAPI 3.0 og OpenAPI 3.1.

Importér

Fil ▸ Importér (Ctrl+I), og derefter en swagger.json- / openapi.json-fil eller direkte URL’en til specifikationen.

Svarer URL’en 401 eller 403, tilbyder Restorm dig at knytte en godkendelse til og prøve igen uden at forlade importdialogen.

Hvad der importeres

Element i specifikationen	Hvad Restorm gør med det
servers (eller host + basePath + schemes)	Miljøets basis-URL, med servervariabler opløst
tags	Én mappe pr. tag, plus en Other-mappe til resten
Hver operation	En HTTP-anmodning, metode og sti inklusive
Parametre	Sti-, forespørgsels- og headerparametre, typede (streng, tal, dato/tid, opremsning, hemmelighed …)
requestBody	Bodyen, i sin indholdstype
examples	Bodyen forudfyldt med det angivne eksempel
components / definitions	API-dokumentationen: modeller, beskrivelser
enum	Opremsninger, der kan genbruges som værditype
Svar	Dokumenteret pr. indholdstype

$ref opløses, også på tværs af komponenterne.

Linjen components / definitions fortjener at blive fremhævet: importen begrænser sig ikke til anmodningerne, den bevarer hele API’ets dokumentation — beskrivelser, modeller, sikkerhedsskemaer, eksempler, opremsninger. Den kan læses på fanen Docs både i den miljømappe, importen har lavet, og i hver enkelt anmodning, og den gensynkroniseres fra kilden. Se Adgang til og opdatering af dokumentationen for et importeret API.

Sikkerhed

De erklærede sikkerhedsskemaer oversættes til forudkoblede headere eller parametre, med den tilhørende miljøvariabel oprettet for dig:

Skema	Det, Restorm sætter op
apiKey i en header eller i forespørgslen	Et par opkaldt efter skemaet, med værdien {{<schema>}}
http + basic	Authorization: Basic {{<schema>_credentials}}
http + bearer, oauth2, openIdConnect	Authorization: Bearer {{<schema>_token}}

Så mangler du blot at udfylde variablen — eller erstatte den med en godkendelsesrute for at få automatisk fornyelse.

Kendte begrænsninger

apiKey, der sendes via en cookie, forudkobles ikke (OpenAPI 3). Et sikkerhedsskema, der refereres, men ikke erklæres, ignoreres i stilhed.

Opdatér

OpenAPI og Swagger er blandt de formater, der kan gensynkroniseres: mappens Opdater-knap henter kilden, og Restorm anvender forskellen — nye operationer tilføjes, forsvundne operationer markeres som forældede frem for at blive slettet, og dine ændringer bevares. Se Opdatér fra kilden.