Документация

Всё, что нужно знать для начала работы с FlexMock

Быстрый старт

1. Зарегистрируйтесь или войдите в систему 2. Перейдите в раздел "Модели" 3. Создайте свою первую модель с помощью визуального редактора 4. Настройте запрос (request) для публикации модели как API эндпоинта 5. Используйте полученный URL в вашем проекте

Создание модели

Модель — это структура данных, которая описывает формат ваших мок-данных. Вы можете создать модель используя визуальный редактор: • Добавляйте поля с помощью кнопки "Добавить поле" • Выбирайте типы данных и Faker.js методы для генерации • Просматривайте примеры сгенерированных данных в реальном времени • Сохраняйте модели для использования в нескольких запросах

Создание запроса

Запрос (Request) — это конфигурация для публикации модели как API эндпоинта: • Выберите модель из списка ваших моделей • Настройте количество элементов в ответе (1-20) • Установите задержку ответа (0-5000 мс) • Настройте контроль доступа (домены или публичный доступ) • Сохраните запрос и получите уникальный URL

Использование API

После создания запроса вы получите URL вида: /{username}/{requestName} Вы можете использовать этот URL в ваших проектах: • Добавьте параметр ?limit=N для указания количества элементов (максимум 20) • Эндпоинт поддерживает CORS и может использоваться из браузера • Ответ приходит в формате JSON массива

Пример
GET /username/my-request?limit=5 Ответ: [ { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "Иван Петров", "email": "ivan.petrov@example.com", "age": 28, "city": "Москва", "isActive": true }, { "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8", "name": "Мария Сидорова", "email": "maria.sidorova@example.com", "age": 32, "city": "Санкт-Петербург", "isActive": true }, { "id": "6ba7b811-9dad-11d1-80b4-00c04fd430c8", "name": "Алексей Иванов", "email": "alexey.ivanov@example.com", "age": 25, "city": "Новосибирск", "isActive": false }, { "id": "6ba7b812-9dad-11d1-80b4-00c04fd430c8", "name": "Елена Смирнова", "email": "elena.smirnova@example.com", "age": 30, "city": "Екатеринбург", "isActive": true }, { "id": "6ba7b813-9dad-11d1-80b4-00c04fd430c8", "name": "Дмитрий Козлов", "email": "dmitry.kozlov@example.com", "age": 27, "city": "Казань", "isActive": true } ]

Готовы начать? Создайте свою первую модель прямо сейчас!

Начать