Import OpenAPI / Swagger
To najbardziej kompletny import w aplikacji Restorm. Rozpoznawane są trzy wersje: Swagger 2.0, OpenAPI 3.0 oraz OpenAPI 3.1.
Import
Section titled “Import”Plik ▸ Importuj (Ctrl+I), a następnie plik swagger.json /
openapi.json albo wprost adres URL specyfikacji.
Jeśli adres URL odpowiada kodem 401 lub 403, Restorm proponuje dołączenie
uwierzytelniania i ponowienie próby, bez zamykania okna dialogowego importu.
Co zostaje zaimportowane
Section titled “Co zostaje zaimportowane”| Element specyfikacji | Co z tym robi Restorm |
|---|---|
servers (lub host + basePath + schemes) | Bazowy adres URL środowiska, z rozwiązanymi zmiennymi serwera |
tags | Jeden folder na etykietę oraz folder Other na pozostałe operacje |
| Każda operacja | Żądanie HTTP wraz z metodą i ścieżką |
| Parametry | Parametry ścieżki i zapytania oraz nagłówki, typowane (ciąg znaków, liczba, data i godzina, wyliczenie, sekret…) |
requestBody | Treść w odpowiednim typie zawartości |
examples | Treść wstępnie wypełniona dostarczonym przykładem |
components / definitions | Dokumentacja API: modele, opisy |
enum | Wyliczenia gotowe do ponownego użycia jako typ wartości |
| Odpowiedzi | Udokumentowane według typu zawartości |
Odwołania $ref są rozwiązywane, również pomiędzy komponentami.
Wiersz components / definitions wart jest podkreślenia: import nie
ogranicza się do żądań, lecz zachowuje całą dokumentację API — opisy,
modele, schematy zabezpieczeń, przykłady, wyliczenia. Jest ona dostępna
w zakładce Docs folderu zmiennych powstałego z importu, a także
w zakładce każdego żądania, i podlega ponownej synchronizacji ze źródłem. Zob.
Dostęp do dokumentacji zaimportowanego API i jej aktualizacja.
Zabezpieczenia
Section titled “Zabezpieczenia”Zadeklarowane schematy zabezpieczeń są przekładane na wstępnie skonfigurowane nagłówki lub parametry, wraz z automatycznie utworzoną odpowiadającą im zmienną środowiskową:
| Schemat | Co ustawia Restorm |
|---|---|
apiKey w nagłówku lub w zapytaniu | Parę nazwaną według schematu, o wartości {{<schema>}} |
http + basic | Authorization: Basic {{<schema>_credentials}} |
http + bearer, oauth2, openIdConnect | Authorization: Bearer {{<schema>_token}} |
Pozostaje tylko wypełnić zmienną — albo zastąpić ją trasą uwierzytelniania, aby korzystać z automatycznego odnawiania.
Aktualizacja
Section titled “Aktualizacja”OpenAPI i Swagger należą do formatów, które można ponownie synchronizować: przycisk Odśwież w folderze pobiera źródło, a Restorm stosuje różnicę — nowe operacje zostają dodane, operacje, które zniknęły, są oznaczane jako przestarzałe, a nie usuwane, wprowadzone zmiany zaś pozostają zachowane. Zob. Aktualizacja ze źródła.