Import OpenAPI / Swagger
Jde o nejúplnější import v aplikaci Restorm. Rozpoznávány jsou tři verze: Swagger 2.0, OpenAPI 3.0 a OpenAPI 3.1.
Import
Section titled “Import”Soubor ▸ Importovat (Ctrl+I), potom soubor swagger.json /
openapi.json, nebo přímo URL specifikace.
Pokud URL odpoví 401 nebo 403, Restorm vám nabídne připojit ověřování
a zkusit to znovu, aniž byste opustili importní dialog.
Co se importuje
Section titled “Co se importuje”| Prvek specifikace | Co s ním Restorm udělá |
|---|---|
servers (nebo host + basePath + schemes) | Základní URL prostředí, s vyřešenými proměnnými serveru |
tags | Jedna složka na štítek a navíc složka Other pro zbytek |
| Každá operace | Požadavek HTTP, včetně metody a cesty |
| Parametry | Parametry cesty, dotazu a hlavičky, typované (řetězec, číslo, datum a čas, výčtový typ, tajný klíč…) |
requestBody | Tělo, ve svém typu obsahu |
examples | Tělo předplněné dodaným příkladem |
components / definitions | Dokumentace API: modely, popisy |
enum | Výčtové typy znovu použitelné jako typ hodnoty |
| Odpovědi | Zdokumentované podle typu obsahu |
Odkazy $ref se vyřeší, a to i napříč komponentami.
Řádek components / definitions si zaslouží zdůraznit: import se neomezuje
na požadavky, uchovává celou dokumentaci API — popisy, modely,
bezpečnostní schémata, příklady, výčtové typy. Je dostupná na kartě
Dokumentace složky proměnných vzniklé importem i na kartě každého
požadavku a znovu se synchronizuje ze zdroje. Viz
Přístup k dokumentaci importovaného API a její aktualizace.
Zabezpečení
Section titled “Zabezpečení”Deklarovaná bezpečnostní schémata se přeloží na předem zapojené hlavičky nebo parametry, přičemž odpovídající proměnná prostředí se vytvoří za vás:
| Schéma | Co Restorm nastaví |
|---|---|
apiKey v hlavičce nebo v dotazu | Pár pojmenovaný podle schématu, hodnota {{<schema>}} |
http + basic | Authorization: Basic {{<schema>_credentials}} |
http + bearer, oauth2, openIdConnect | Authorization: Bearer {{<schema>_token}} |
Zbývá už jen doplnit proměnnou — nebo ji nahradit ověřovací trasou a získat tak automatické obnovování.
Aktualizace
Section titled “Aktualizace”OpenAPI a Swagger patří mezi formáty, které lze znovu synchronizovat: tlačítko Aktualizovat na složce znovu načte zdroj a Restorm použije rozdíl — nové operace se přidají, zmizelé operace se označí jako zavržené, nikoli smazané, a vaše úpravy zůstanou zachovány. Viz Aktualizace ze zdroje.