Генератор тестового API

Пошаговая инструкция: как создать и тестировать mock API в FSQL

Этот сервис помогает быстро создать временный REST API на основе ваших шаблонов таблиц и схем связей, а затем сразу проверить его через встроенный Конструктор REST-запросов.

• 1. Подготовьте источник схемы

  • Создайте и сохраните шаблон таблицы на главной странице FSQL либо заранее настройте связь между шаблонами в режиме relations.
  • Именно эти сущности затем можно использовать как источник схемы для временного API.
  • Если нужен API для одной таблицы — выбирайте шаблон. Если нужен API с несколькими связанными сущностями — используйте relations.

• 2. Выберите источник в API Generator

  • В блоке «Источник схемы» выберите, откуда строить API: из шаблона generator или из relations.
  • Для шаблона вы получите API по одной сущности, для relations — более сложный API со связанными сущностями.
  • Если вы перешли в API Generator по кнопке API из списка шаблонов или связей на главной странице, источник и объект уже будут выбраны автоматически.

• 3. Настройте параметры API

  • Укажите runtime API, количество строк на сущность и TTL временного API.
  • Эти параметры влияют на объём тестовых данных и срок жизни созданного mock API.
  • Количество строк на сущность используется не только для генерации данных, но и для расчёта списания строк с баланса.

• 4. Посмотрите preview

  • Нажмите «Показать preview», чтобы заранее увидеть сущности, endpoints и примеры ответов.
  • Preview помогает проверить схему до запуска создания API.
  • В этом блоке можно заранее понять, сколько сущностей будет создано, какие endpoints появятся и как примерно будут выглядеть ответы.

• 5. Создайте временный REST API

  • Нажмите «Создать API», дождитесь завершения генерации и получите внутреннюю и публичную ссылки.
  • После создания сервис покажет OpenAPI JSON, Swagger UI и список endpoints.
  • Создание API списывает строки с баланса по объёму данных: учитываются строки на сущность, количество сущностей и отдельный коэффициент API.

• 6. Откройте блок «Конструктор REST-запросов»

  • После успешного создания API в блоке API появляется встроенный Конструктор REST-запросов.
  • Он нужен для быстрой проверки методов без Postman, curl и сторонних клиентов.
  • Через него можно собирать GET, POST, PATCH и DELETE запросы по уже созданной схеме API.

• 7. Как работает GET и POST(Insert) в конструкторе

  • В левой части конструктора есть блок «Запросы: GET и POST(Insert)».
  • Для GET можно включать флаги page, limit, include_meta, distinct и nested_relations.
  • Параметр fields позволяет выбрать, какие поля должны вернуться в ответе. Значение __all__ означает возврат всех полей.
  • Параметр sort позволяет выбрать одно или несколько полей сортировки и указать направление asc или desc.
  • Параметр join_to используется, когда нужно присоединить связанную сущность.
  • join_type позволяет выбрать тип присоединения, например inner или left.
  • response_mode позволяет переключать формат ответа между более плоским и более вложенным представлением данных.
  • Для POST(Insert) конструктор показывает готовые примеры BODY, чтобы можно было быстро проверить вставку данных в созданный mock API.

• 8. Как работает PATCH(Update) и DELETE

  • В правой части конструктора расположен блок «Запросы: PATCH(Update) и DELETE».
  • Там строится выражение WHERE для массового обновления или удаления строк.
  • Блок Preview выражения WHERE показывает человекочитаемый вариант условий.
  • Блок Preview JSON where показывает точный JSON, который будет отправлен в API.
  • Для PATCH дополнительно выбираются set field и set value — то есть какое поле нужно изменить и на какое значение.
  • Это позволяет тестировать не только чтение, но и сценарии обновления и удаления данных прямо в интерфейсе.

• 9. Что делает кнопка «Карта параметров»

  • Кнопка «Карта параметров» открывает компактную памятку по параметрам конструктора и их смыслу.
  • Она помогает быстро вспомнить, какие параметры доступны у GET-запросов, как работают join_to, join_type, response_mode, sort, fields и другие опции.
  • Этот блок особенно полезен, если API содержит несколько сущностей и связей.

• 10. Что происходит при нажатии кнопки «Тест»

  • Кнопка «Тест» отправляет реальный запрос в уже созданный mock API и показывает ответ прямо в интерфейсе.
  • Тест используется не только для просмотра примера, но и для проверки фактической работы метода, фильтров, сортировки, пагинации и условий WHERE.
  • За каждый тестовый вызов списываются строки с баланса по отдельному коэффициенту, который меньше, чем при полном создании API.
  • Списание при тесте рассчитывается от параметра «Строк на сущность» и отдельного множителя для test-запросов.

• 11. Как использовать полученный API в работе

  • Публичную ссылку можно использовать для frontend-разработки, демонстраций, интеграций и QA-проверок.
  • OpenAPI JSON и Swagger UI подходят для быстрой передачи контракта команде и подключения внешних клиентов.
  • Если срок жизни API подходит к концу, его можно продлить прямо из интерфейса.