Перейти до вмісту

Створити мок REST API

Створюйте фейкові ендпоінти JSON зі своїм методом, шляхом, статусом, затримкою й тілом відповіді або згенерованими даними. Вони працюють із CORS на нашому сервері для прототипів і тестів.

Для параметра використовуйте :name, наприклад /users/:id

Тіло відповіді
Затримка0 ms

Рядки на кшталт "{{fullName}}" або "{{int(1, 100)}}" замінюються під час кожного запиту.

елементів

0 — повернути один обʼєкт

Плейсхолдери (36)
{{id}}
1, 2, 3… позиція в списку
{{index}}
0, 1, 2… позиція з нуля
{{uuid}}
Випадковий UUID v4
{{firstName}}
Імʼя
{{lastName}}
Прізвище
{{fullName}}
Імʼя та прізвище
{{username}}
Нік малими літерами
{{email}}
Адреса на example.com
{{phone}}
Номер телефону (+1 555…)
{{company}}
Назва компанії
{{jobTitle}}
Посада
{{street}}
Вулиця й номер будинку
{{city}}
Місто
{{country}}
Країна
{{countryCode}}
Код ISO 3166
{{zip}}
5-значний поштовий індекс
{{domain}}
домен example
{{url}}
URL із https
{{ipv4}}
IPv4 з діапазону для документації
{{color}}
Колір HEX
{{word}}
Одне слово lorem
{{words}}
words(n): n слів lorem
{{sentence}}
Речення lorem
{{paragraph}}
Від трьох до пʼяти речень
{{int}}
int(min, max): ціле число
{{float}}
float(min, max, decimals)
{{price}}
price(min, max): два десяткові знаки
{{bool}}
true або false
{{date}}
Дата за минулий рік (РРРР-ММ-ДД)
{{datetime}}
Дата й час ISO за минулий рік
{{futureDate}}
Дата протягом наступного року
{{status}}
active, pending або inactive
{{pick}}
pick(a, b, c): один із варіантів
{{param}}
param(name): значення зі шляху URL, наприклад :id
{{query}}
query(name): значення з рядка запиту
{{null}}
JSON null
Заголовки відповіді (необовʼязково, лише X-)
Ендпоїнтів: 3 з 10 · відповіді JSON з увімкненим CORS
Обробляється на нашому сервері · JSON ендпоінта зберігається, доки ви його не видалите або доки не мине 7 днів без жодного запитуЯк це працює

Як користуватися: Мок REST API

  1. 1

    Опишіть кожен ендпоінт

    Виберіть метод, введіть шлях, наприклад /users/:id, а також код статусу й за потреби затримку, щоб імітувати повільну мережу.

  2. 2

    Напишіть відповідь

    Вставте фіксований JSON або перейдіть на «Фейкові дані» і напишіть шаблон із плейсхолдерами на кшталт {{fullName}} та вкажіть розмір списку.

  3. 3

    Створіть мок-API

    Натисніть «Створити мок-API», щоб отримати базову URL-адресу: кожен ендпоінт відповідає за цією адресою плюс його шлях, а CORS увімкнено.

  4. 4

    Викликайте й вдосконалюйте

    Скористайтеся кнопкою «Спробувати», curl або fetch у своєму застосунку, потім змініть і збережіть — зміни діють одразу — або видаліть мок, коли він більше не потрібен.

Ліміти та Pro

Безкоштовно: 10 ендпоінтів на один мок-API, 100 KB на тіло й 512 KB загалом, затримка до 5 секунд, згенеровані списки до 100 елементів, 120 запитів на хвилину від одного відвідувача, 10 нових мок-API на годину, видалення через 7 днів без запитів.

Pro підвищує ліміти до 50 ендпоінтів, тіл до 1 MB, затримок до 30 секунд і списків до 1 000 елементів. Дивитися Pro

Про інструмент: Мок REST API

Mock REST API дає фронтенд- і мобільним розробникам робочі ендпоінти ще до появи справжнього бекенду. Кожен мок-API має власну базову URL-адресу в /api/mock-api/m/, а кожен ендпоінт, який ви визначите, відповідає там із указаними вами методом, шляхом, кодом статусу, затримкою, заголовками й тілом JSON. Шляхи можуть містити параметри, тож /users/:id відповідає на /users/7, а шаблон може повернути це значення через {{param(id)}} або прочитати рядок запиту через {{query(name)}}.

Режим фейкових даних перетворює шаблон JSON на реалістичні відповіді за допомогою 36 плейсхолдерів: від імен, електронних адрес, компаній і міст до UUID, дат, цін, чисел у діапазоні та тексту lorem. Вкажіть розмір списку, щоб отримувати масив до 100 елементів, і виберіть, чи дані лишаються однаковими між запитами (це зручно для снапшот-тестів), чи щоразу змінюються. Коди статусів від 200 до 599 дають змогу відпрацювати помилки, як-от 401, 404, 429 і 503, а затримка до пʼяти секунд покаже, як поводяться стани завантаження.

Відповіді завжди мають формат JSON із заголовками CORS, тому їх можуть викликати браузери з будь-якого джерела. Мок-API не вміє віддавати HTML, встановлювати cookie чи перенаправляти, не зберігає отримані запити і не є базою даних: POST і PUT відповідають налаштованим вами тілом, нічого не зберігаючи з надісланого.

Приватність

Щоб розміщувати ваші ендпоінти, збережені вами визначення — методи, шляхи, коди статусів, затримки, заголовки й тіла — надсилаються на наш сервер і зберігаються там разом із хешем токена редагування, часом створення та останнього запиту й лічильником запитів. Запити до ваших ендпоінтів обробляються без запису їхніх тіл, заголовків чи IP-адрес. Мок-API видаляється, коли ви його видаляєте або через 7 днів без запитів і змін, а токен редагування зберігається лише в цьому браузері. Будь-хто, хто має URL, може викликати ваші ендпоінти, тож не розміщуйте в них секрети чи справжні персональні дані.

Можливості

Справжні ендпоінти HTTPS

Будь-який метод, параметри шляху, коди статусів від 200 до 599, затримки й власні заголовки X-.

Шаблони фейкових даних

Понад 30 плейсхолдерів для людей, компаній, місць, дат, чисел і тексту — як один обʼєкт або список.

Безпека за задумом

Лише JSON, CORS увімкнено, без журналів запитів, токен редагування хешується, видалення через 7 днів без використання.

Мок REST API: поширені запитання

Що зберігається на вашому сервері й як довго?
Ми зберігаємо визначення ендпоінтів, які ви зберегли, хеш SHA-256 вашого токена редагування, час створення мок-API та останнього виклику, а також кількість отриманих запитів. Тіла запитів, заголовки та IP-адреси ми не записуємо. Кожен мок-API видаляється, коли ви натискаєте «Видалити», або автоматично, коли минає 7 днів без запитів і змін, тож API, яким ви користуєтеся, залишається доступним.
Чи можна викликати мок-API зі свого фронтенд-застосунку?
Так. Кожна відповідь містить Access-Control-Allow-Origin зі значенням *, а preflight-запити OPTIONS обробляються, тож fetch, axios чи будь-який HTTP-клієнт у браузері на будь-якому домені, зокрема localhost, може його викликати. Використовуйте базову URL-адресу плюс шлях ендпоінта, наприклад fetch(base + "/users"). Мобільні застосунки, Postman і curl теж працюють, бо ендпоінти — це звичайні адреси HTTPS.
Як працюють плейсхолдери фейкових даних?
У режимі «Фейкові дані» будь-який рядок у вашому шаблоні JSON, що є плейсхолдером, наприклад "{{email}}" чи "{{int(1, 100)}}", замінюється, коли надходить запит, а плейсхолдери чисел і true або false, що займають увесь рядок, стають справжніми числами й булевими значеннями JSON. Плейсхолдери можуть бути й усередині тексту, як-от "Hello {{firstName}}". Вкажіть розмір списку, щоб повторити шаблон: {{id}} рахуватиме 1, 2, 3 для кожного елемента.
Чи може мок повертати помилки або повільні відповіді?
Так. Виберіть будь-який статус від 200 до 599, наприклад 401 Unauthorized, 404 Not Found, 422 для помилок валідації, 429 Too Many Requests чи 503, і напишіть JSON помилки, якого очікує ваш застосунок. Повзунок затримки утримує кожну відповідь до 5 секунд у безкоштовному тарифі, що допомагає тестувати спінери, тайм-аути й повторні спроби. Відповіді зі статусом 204 і 304 надсилаються без тіла.
Чому мок-API не може повертати HTML чи встановлювати cookie?
Безкоштовні ендпоінти, що віддають довільний вміст, часто використовують для фішингових сторінок і посилань на шкідливе ПЗ. Щоб ці моки лишалися корисними лише як API, кожна відповідь має тип application/json із nosniff і жорсткою політикою безпеки вмісту, а дозволені лише власні заголовки, що починаються з X-, тож моки не можуть встановлювати cookie, перенаправляти браузери чи вдавати вебсторінку.