Aller au contenu

Dizajner API-ja

Dizajner API-ja omogućava vam da dizajnirate kompletan API direktno u Restormu: opišete svoje podatke i rute, a Restorm se pobrine za ostalo — poslužuje vaš dizajn kao pravi mock server i generiše kod vaše aplikacije na osnovu šablona.

To je idealan alat za pokretanje API-ja pre nego što postoji back-end: oblikujte ugovor, dajte ga svojim klijentima na testiranje i držite sve verzionisano u svom projektu.

Pregled dizajnera API-ja: bočna traka prikazuje modele, enume, rute, server, klijente i kod

Dizajn se kreira kao i svaki drugi element: desni klik na fasciklu ▸ Dodaj ▸ Dizajn API-ja. Otvara se u sopstvenoj kartici i objedinjuje nekoliko sekcija dostupnih iz bočne trake:

SekcijaČemu služi
ModeliVaši entiteti i njihova svojstva — vidi Modeli, enumi i svojstva.
EnumiZatvoreni skupovi vrednosti, ponovo upotrebljivi kao tip svojstva.
RuteUlazne tačke API-ja, grupisane po resursu — vidi Rute i CRUD.
ServerPosluživanje dizajna kao mock, u HTTP-u, GraphQL-u, SOAP-u, OData-i ili gRPC-u — vidi Posluživanje dizajna kao mock.
KlijentiZahtevi spremni za upotrebu koji pozivaju pokrenuti mock — vidi Klijenti.
Dokumentacija i BeleškeDokumentacija i slobodne beleške pridružene dizajnu.
KodGenerisanje koda na osnovu vaših šablona — vidi Generisanje koda.

Podešavanja dizajna (naziv, podrazumevane vrednosti) otvaraju se klikom direktno na čvor dizajna u bočnoj traci.

  1. Opišite svoje podatke — kreirajte svoje modele i enume, dodajte njihova svojstva, tipove i ograničenja.
  2. Definišite svoje rute — ručno ili jednim klikom pomoću Generiši CRUD iz modela.
  3. Poslužite mock — pokrenite server i usmerite na njega svoju aplikaciju ili klijenta. Isti dizajn se automatski projektuje u svaki aktivirani protokol.
  4. Generišite kod — izaberite jedan ili više šablona (svoje ili one koje nudi Restorm) i proizvedite odgovarajući projekat.

Svaki korak detaljno je opisan na stranicama ove sekcije.