Import API
Restorm rozpoznaje dwadzieścia cztery formaty i odtwarza na ich podstawie kompletne drzewo projektu: foldery, żądania, środowiska, dokumentację API, wyliczenia.
To niemal zawsze najlepszy punkt wyjścia: nie warto pisać żądań ręcznie, jeśli istnieje już specyfikacja.
Jak importować
Section titled “Jak importować”Plik ▸ Importuj (Ctrl+I) przyjmuje:
- plik z dysku;
- adres URL — przydatny dla pliku
swagger.jsonlub dokumentu$metadataudostępnionego online; - wklejoną treść — w ten sposób polecenie
curlzamienia się w żądanie.
Restorm sam rozpoznaje format: najpierw na podstawie rozszerzenia pliku, a następnie analizując treść. Nie trzeba niczego wybierać.
Formaty
Section titled “Formaty”Specyfikacje API
Section titled “Specyfikacje API”| Format | Strona |
|---|---|
| OpenAPI 3.x i Swagger 2.0 | OpenAPI / Swagger |
| Schemat GraphQL (SDL) | GraphQL |
Pliki .proto i refleksja gRPC | gRPC |
| WSDL | SOAP / WSDL |
| AsyncAPI | AsyncAPI |
| OData EDMX / CSDL | OData |
| OpenRPC | OpenRPC |
| Schemat tRPC | tRPC |
| Smithy | Smithy |
| TypeSpec | TypeSpec |
| RAML | RAML |
| WADL | WADL |
| Thrift | Thrift |
| API Blueprint | API Blueprint |
Kolekcje innych klientów
Section titled “Kolekcje innych klientów”| Format | Strona |
|---|---|
| Postman | Postman |
| Insomnia | Insomnia |
| Bruno | Bruno |
| Thunder Client | Thunder Client |
| Paw / RapidAPI | Paw |
| HTTPie | HTTPie |
VS Code REST Client (.http) | REST Client |
Przechwycenia i wiersze poleceń
Section titled “Przechwycenia i wiersze poleceń”| Format | Strona |
|---|---|
| HAR (przechwycenie z przeglądarki) | HAR |
Polecenia curl | cURL |
Invoke-RestMethod / Invoke-WebRequest | PowerShell |
Co się otrzymuje
Section titled “Co się otrzymuje”W zależności od tego, jak bogaty jest format źródłowy:
- folder zmiennych z jednym środowiskiem lub kilkoma, wraz z bazowym adresem URL wyodrębnionym ze specyfikacji;
- drzewo folderów — według etykiety, usługi albo zasobu, zależnie od formatu;
- jedno żądanie na operację, w typie odpowiadającym protokołowi;
- dokumentację API dołączoną do folderu: modele, opisy, schematy zabezpieczeń, przykładowe odpowiedzi;
- wyliczenia ze specyfikacji, gotowe do ponownego użycia jako typ wartości;
- wstępnie skonfigurowane nagłówki uwierzytelniania wraz z ich zmiennymi — zob. Uwierzytelnianie.
Po imporcie każda para klucz / wartość, której wartość rozwiązuje się do pustego ciągu, zostaje automatycznie wyłączona: pierwsze wysłanie nie rusza więc z chmarą pustych nagłówków.
Dokumentacja zaimportowanego API
Section titled “Dokumentacja zaimportowanego API”Import nie tworzy wyłącznie żądań: zachowuje również dokumentację API — opisy, modele, zabezpieczenia, przykłady, wyliczenia — dostępną w zakładce Docs utworzonego folderu. Zob. Dostęp do dokumentacji zaimportowanego API i jej aktualizacja.
Aktualizacja importu
Section titled “Aktualizacja importu”Dwanaście formatów można ponownie zsynchronizować: Restorm porównuje nową wersję źródła z istniejącym drzewem i stosuje różnicę, bez utraty wprowadzonych zmian. Zob. Aktualizacja ze źródła.
A co z eksportem?
Section titled “A co z eksportem?”Restorm generuje fragmenty kodu dla każdego żądania, we wszystkich językach istotnych dla danego protokołu. Zob. Eksport kodu.