Az API-tervező

Az API-tervező lehetővé teszi, hogy egy teljes API-t közvetlenül a Restormban tervezzen meg: leírja az adatait és az útvonalait, a Restorm pedig elvégzi a többit — kiszolgálja a tervét, mint egy valódi mock szerver, és generálja az alkalmazása kódját sablonok alapján.

Ez az ideális eszköz egy API elindításához, mielőtt a háttérrendszer létezne: modellezze a szerződést, teszteltesse az ügyfeleivel, és tartsa az egészet verziókövetve a projektjében.

Egy terv, több szakasz

Egy terv úgy jön létre, mint bármely más elem: jobb kattintás egy mappán ▸ Hozzáadás ▸ API-terv. Saját lapon nyílik meg, és több szakaszt fog össze, amelyek az oldalsávból érhetők el:

Szakasz	Mire szolgál
Modellek	Az entitásai és tulajdonságaik — lásd Modellek, enumok és tulajdonságok.
Enumok	Zárt értékkészletek, tulajdonságtípusként újrafelhasználhatók.
Útvonalak	Az API belépési pontjai, erőforrás szerint csoportosítva — lásd Útvonalak és CRUD.
Szerver	A terv kiszolgálása mockként HTTP, GraphQL, SOAP, OData vagy gRPC protokollon — lásd A terv kiszolgálása mockként.
Ügyfelek	Kész kérések, amelyek a futó mockot hívják — lásd Ügyfelek.
Dokumentáció & Jegyzetek	A tervhez csatolt dokumentáció és szabad jegyzetek.
Kód	Kódgenerálás a sablonjaiból — lásd Kódgenerálás.

A terv beállításai (név, alapértelmezett értékek) úgy nyílnak meg, hogy közvetlenül a terv csomópontjára kattint az oldalsávban.

A tipikus folyamat

1. Írja le az adatait — hozza létre a modelljeit és enumjait, adja hozzá a tulajdonságaikat, típusaikat és megszorításaikat.
2. Határozza meg az útvonalait — kézzel, vagy egyetlen kattintással a CRUD generálása funkcióval egy modellből.
3. Szolgálja ki a mockot — indítsa el a szervert, és irányítsa rá az alkalmazását vagy egy ügyfelet. Ugyanazt a tervet automatikusan minden engedélyezett protokollra levetíti.
4. Generálja a kódot — válasszon egy vagy több sablont (a sajátjait vagy a Restorm által kínáltakat), és állítsa elő a megfelelő projektet.

Minden lépés részletesen le van írva ennek a szakasznak az oldalain.