Import pliku TypeSpec

TypeSpec (Microsoft) opisuje API w dedykowanym języku, a następnie kompiluje je do OpenAPI. Restorm idzie tą samą drogą.

Importowanie

Plik ▸ Importuj (Ctrl+I), a następnie plik .tsp z dysku.

Restorm kompiluje plik do OpenAPI 3.x za pomocą wbudowanego kompilatora TypeSpec, po czym przekazuje wynik do importu OpenAPI. Rezultatem jest więc dokładnie to samo bogate drzewo: foldery według etykiet, otypowane żądania, dokumentacja, wstępnie podłączone zabezpieczenia.

Model zaufania

Treść pliku .tsp jest kopiowana do odizolowanego katalogu tymczasowego, w którym Restorm montuje własne zależności. W konsekwencji plik tspconfig.yaml ani katalog node_modules znajdujące się obok pliku źródłowego nigdy nie są brane pod uwagę. Kompilacja nie może więc wykonać dowolnego kodu pochodzącego z drzewa katalogów użytkownika.

Ograniczenia

• Wyłącznie plik lokalny. Wklejanie treści oraz import przez adres URL są odrzucane z jednoznacznym komunikatem.
• Specyfikacja w jednym pliku. Względne importy do sąsiednich plików .tsp nie są rozwiązywane — to bezpośrednia konsekwencja opisanej powyżej izolacji. Jeśli model jest podzielony na kilka plików, należy samodzielnie skompilować go do OpenAPI i zaimportować wynik.