Дизайнер API

Дизайнер API дозволяє вам спроєктувати повноцінний API безпосередньо в Restorm: ви описуєте свої дані та маршрути, а Restorm бере на себе решту — він віддає ваш проєкт як справжній mock-сервер і генерує код вашого застосунку на основі шаблонів.

Це ідеальний інструмент, щоб запустити API ще до того, як існує бекенд: змакетуйте контракт, дайте своїм клієнтам його протестувати, і тримайте все під контролем версій усередині вашого проєкту.

Один проєкт, кілька розділів

Проєкт створюється як будь-який інший елемент: правий клік на теці ▸ Додати ▸ Проєкт API. Він відкривається у власній вкладці й об’єднує кілька розділів, доступних з бічної панелі:

Розділ	Для чого він служить
Моделі	Ваші сутності та їхні властивості — див. Моделі, enum-и та властивості.
Enum-и	Замкнені набори значень, придатні для повторного використання як тип властивості.
Маршрути	Точки входу API, згруповані за ресурсом — див. Маршрути та CRUD.
Сервер	Віддавання проєкту як mock у HTTP, GraphQL, SOAP, OData чи gRPC — див. Віддавання проєкту як mock.
Клієнти	Готові до використання запити, що викликають запущений mock — див. Клієнти.
Документація та Нотатки	Документація та вільні нотатки, прикріплені до проєкту.
Код	Генерація коду з ваших шаблонів — див. Генерація коду.

Налаштування проєкту (назва, значення за замовчуванням) відкриваються кліком безпосередньо на вузлі проєкту в бічній панелі.

Типовий шлях

1. Опишіть свої дані — створіть свої моделі та enum-и, додайте їхні властивості, типи й обмеження.
2. Визначте свої маршрути — вручну або одним кліком за допомогою Згенерувати CRUD з моделі.
3. Віддайте mock — запустіть сервер і спрямуйте на нього ваш застосунок чи клієнта. Той самий проєкт автоматично проєктується в кожен увімкнений протокол.
4. Згенеруйте код — виберіть один або кілька шаблонів (ваші власні або запропоновані Restorm) і створіть відповідний проєкт.

Кожен крок детально описаний на сторінках цього розділу.