Návrhář API
Návrhář API vám umožňuje navrhnout kompletní API přímo v Restormu: popíšete svá data a trasy a Restorm se postará o zbytek — servíruje váš návrh jako skutečný mock server a generuje kód vaší aplikace na základě šablon.
Je to ideální nástroj pro rozjezd API dříve, než existuje back-end: namodelujte kontrakt, nechte ho otestovat svými klienty a udržujte vše verzované ve svém projektu.
Jeden návrh, více sekcí
Section titled “Jeden návrh, více sekcí”Návrh se vytváří jako kterýkoli jiný prvek: pravé tlačítko myši na složce ▸ Přidat ▸ Návrh API. Otevře se ve vlastní kartě a sdružuje několik sekcí přístupných z postranního panelu:
| Sekce | K čemu slouží |
|---|---|
| Modely | Vaše entity a jejich vlastnosti — viz Modely, enumy a vlastnosti. |
| Enumy | Uzavřené množiny hodnot, znovupoužitelné jako typ vlastnosti. |
| Trasy | Vstupní body API, seskupené podle zdroje — viz Trasy a CRUD. |
| Server | Servírování návrhu jako mock, v HTTP, GraphQL, SOAP, OData nebo gRPC — viz Servírování návrhu jako mock. |
| Klienti | Připravené požadavky, které volají běžící mock — viz Klienti. |
| Dokumentace a Poznámky | Dokumentace a volné poznámky připojené k návrhu. |
| Kód | Generování kódu na základě vašich šablon — viz Generování kódu. |
Nastavení návrhu (název, výchozí hodnoty) se otevírá kliknutím přímo na uzel návrhu v postranním panelu.
Typický průběh
Section titled “Typický průběh”- Popište svá data — vytvořte své modely a enumy, přidejte jejich vlastnosti, typy a omezení.
- Definujte své trasy — ručně nebo jedním kliknutím pomocí Generovat CRUD z modelu.
- Servírujte mock — spusťte server a nasměrujte na něj svou aplikaci nebo klienta. Tentýž návrh je automaticky promítnut do každého aktivovaného protokolu.
- Vygenerujte kód — zvolte jednu nebo více šablon (vlastní nebo ty nabízené Restormem) a vytvořte odpovídající projekt.
Každý krok je podrobně popsán na stránkách této sekce.