Projektant API

Projektant API pozwala zaprojektować kompletne API bezpośrednio w Restorm: opisuje Pan/Pani swoje dane i trasy, a Restorm zajmuje się resztą — serwuje Pana/Pani projekt jak prawdziwy serwer mock oraz generuje kod Pana/Pani aplikacji na podstawie szablonów.

To idealne narzędzie, aby rozpocząć pracę nad API, zanim jeszcze powstanie back-end: proszę zamodelować kontrakt, dać go do przetestowania swoim klientom i przechowywać całość wersjonowaną w swoim projekcie.

Jeden projekt, wiele sekcji

Projekt tworzy się jak każdy inny element: prawy przycisk myszy na folderze ▸ Dodaj ▸ Projekt API. Otwiera się we własnej karcie i grupuje kilka sekcji dostępnych z paska bocznego:

Sekcja	Do czego służy
Modele	Pana/Pani encje i ich właściwości — zobacz Modele, enumy i właściwości.
Enumy	Zamknięte zbiory wartości, wielokrotnego użytku jako typ właściwości.
Trasy	Punkty wejścia API, pogrupowane według zasobu — zobacz Trasy i CRUD.
Serwer	Serwowanie projektu jako mock, w HTTP, GraphQL, SOAP, OData lub gRPC — zobacz Serwowanie projektu jako mock.
Klienci	Gotowe do użycia żądania, które wywołują działający mock — zobacz Klienci.
Dokumentacja i Notatki	Dokumentacja i dowolne notatki dołączone do projektu.
Kod	Generowanie kodu na podstawie Pana/Pani szablonów — zobacz Generowanie kodu.

Ustawienia projektu (nazwa, wartości domyślne) otwierają się po kliknięciu bezpośrednio węzła projektu na pasku bocznym.

Typowa ścieżka

1. Proszę opisać swoje dane — utworzyć modele i enumy, dodać ich właściwości, typy i ograniczenia.
2. Proszę zdefiniować swoje trasy — ręcznie lub jednym kliknięciem za pomocą Generuj CRUD z modelu.
3. Proszę serwować mock — uruchomić serwer i skierować na niego swoją aplikację lub klienta. Ten sam projekt jest automatycznie rzutowany na każdy włączony protokół.
4. Proszę wygenerować kod — wybrać jeden lub kilka szablonów (własnych lub tych proponowanych przez Restorm) i wytworzyć odpowiadający im projekt.

Każdy etap jest szczegółowo opisany na stronach tej sekcji.