Dizajner API-ja
Dizajner API-ja omogućuje vam da dizajnirate cjelovit API izravno u Restormu: opišete svoje podatke i rute, a Restorm se pobrine za ostalo — poslužuje vaš dizajn poput pravog mock poslužitelja i generira kod vaše aplikacije na temelju predložaka.
To je idealan alat za pokretanje API-ja prije nego što postoji back-end: oblikujte ugovor, dajte ga svojim klijentima na testiranje i držite sve verzionirano u svom projektu.
Jedan dizajn, više odjeljaka
Section titled “Jedan dizajn, više odjeljaka”Dizajn se stvara kao i svaki drugi element: desni klik na mapu ▸ Dodaj ▸ Dizajn API-ja. Otvara se u vlastitoj kartici i objedinjuje nekoliko odjeljaka dostupnih iz bočne trake:
| Odjeljak | Čemu služi |
|---|---|
| Modeli | Vaši entiteti i njihova svojstva — vidi Modeli, enumi i svojstva. |
| Enumi | Zatvoreni skupovi vrijednosti, ponovno upotrebljivi kao tip svojstva. |
| Rute | Ulazne točke API-ja, grupirane po resursu — vidi Rute i CRUD. |
| Poslužitelj | Posluživanje dizajna kao mock, u HTTP-u, GraphQL-u, SOAP-u, OData-i ili gRPC-u — vidi Posluživanje dizajna kao mock. |
| Klijenti | Zahtjevi spremni za upotrebu koji pozivaju pokrenuti mock — vidi Klijenti. |
| Dokumentacija i Bilješke | Dokumentacija i slobodne bilješke priložene dizajnu. |
| Kod | Generiranje koda na temelju vaših predložaka — vidi Generiranje koda. |
Postavke dizajna (naziv, zadane vrijednosti) otvaraju se klikom izravno na čvor dizajna u bočnoj traci.
Tipičan tijek
Section titled “Tipičan tijek”- Opišite svoje podatke — stvorite svoje modele i enume, dodajte njihova svojstva, tipove i ograničenja.
- Definirajte svoje rute — ručno ili jednim klikom pomoću Generiraj CRUD iz modela.
- Poslužite mock — pokrenite poslužitelj i usmjerite na njega svoju aplikaciju ili klijenta. Isti dizajn automatski se projicira u svaki aktivirani protokol.
- Generirajte kod — odaberite jedan ili više predložaka (vlastite ili one koje nudi Restorm) i proizvedite odgovarajući projekt.
Svaki korak detaljno je opisan na stranicama ovog odjeljka.