TypeSpec-fájl importálása

A TypeSpec (Microsoft) saját nyelven írja le az API-t, majd OpenAPI-ra fordítja. A Restorm ugyanezt az utat követi.

Importálás

Fájl ▸ Importálás (Ctrl+I), majd egy .tsp fájl a gépről.

A Restorm a beépített TypeSpec-fordítójával OpenAPI 3.x formára fordítja a fájlt, majd az eredményt átadja az OpenAPI-importálásnak. Az eredmény tehát pontosan ugyanaz a tartalmas fa: mappák címkék szerint, típusos kérések, dokumentáció, előre bekötött biztonság.

Bizalmi modell

A .tsp tartalom egy elszigetelt, ideiglenes mappába kerül, amelybe a Restorm a saját függőségeit csatolja be. Ennek következménye, hogy a forrásfájl mellett található tspconfig.yaml vagy node_modules soha nem kerül felhasználásra. A fordítás így nem tud tetszőleges kódot futtatni a saját fájlszerkezetünkből.

Korlátok

• Csak helyi fájl. A beillesztést és az URL-ről történő importálást a Restorm érthető üzenettel elutasítja.
• Egyetlen fájlból álló specifikáció. A szomszédos .tsp fájlokra mutató relatív importok nem oldódnak fel — ez a fenti elszigetelés közvetlen következménye. Több fájlra szétvágott modell esetén magunknak kell OpenAPI-ra fordítani, és az eredményt importálni.