MOKKY / Документация
  • 👋Добро пожаловать в Mokky
  • Вступление
    • 👀С чего начинать?
    • 🔏Регистрация
    • 🗂️Как создать проект
    • 📄Как создать ресурс
    • ⚒️Примеры на React/JS
  • Обращение к ресурсам
    • 📃Обращение к API
    • 🔍Фильтрация
      • Простой поиск
      • Расширенная фильтрация
      • По нескольким параметрам
      • По нескольким значениям
      • Глубокая фильтрация
    • ↕️Сортировка
    • 🔢Пагинация
    • 📄Выборка полей
    • 🔛Связь двух ресурсов
  • Доп. настройки
    • JSON-генератор
    • Аутентификация
      • Защита ресурсов
      • Пример кода
      • Обращение к защищенным ресурсам
      • Получение авторизованного пользователя
    • Загрузка файлов
    • Инкрементировать поле
    • Разрешённые методы
    • Фейковый статус
Powered by GitBook
On this page
  1. Обращение к ресурсам

Обращение к API

PreviousПримеры на React/JSNextФильтрация

Last updated 7 months ago

Теперь перейдём к самому главному — обращение к ресурсам через API.

После того, как вы создали свой проект, Mokky генерирует для него уникальный ID.

Именно через этот API-адрес вы в дальнейшем сможете обращаться к вашим ресурсам, фильтровать их, добавлять, редактировать, обновлять и т.п.

Например, можем запросить все товары через ресурс /items

Методы

Для каждого ресурса доступны следующие HTTP-методы:

  • GET — Получение всех записей или одной, фильтрация, пагинация

  • POST — Добавление записи

  • PATCH — Обновление записи

  • DELETE — Удаление записи

В качестве примера, возьмём тот же ресурс /items

GET /items Получение всех товаров
// https://d774fe2b8f07493b.mokky.dev/items

[
  {
     "id": 1,
     "title": "Мужские Кроссовки Nike Blazer Mid Suede",
     "price": 12999,
     "imageUrl": "/sneakers/sneakers-1.jpg"
  }
]
GET /items/1 Получение одного товара
// https://d774fe2b8f07493b.mokky.dev/items/1

{
  "id": 1,
  "title": "Мужские Кроссовки Nike Blazer Mid Suede",
  "price": 12999,
  "imageUrl": "/sneakers/sneakers-1.jpg"
}
POST /items Создание товара

Отправляем в Mokky новый объект:

{
  "title": "Nike Air Max 270",
  "price": 15600,
  "imageUrl": "/sneakers/sneakers-2.jpg"
}

Получаем в ответ тот же объект, но уже с ID:

{
  "id": 1, <--- сервер автоматически генерирует ID
  "title": "Nike Air Max 270",
  "price": 15600,
  "imageUrl": "/sneakers/sneakers-2.jpg"
}
PATCH /items/1 Обновление товара

К примеру, если мы хотим обновить стоимость товара, отправляем на сервер объект и в адресе ресурса обязательно указываем ID обновляемого объекта:

// PATCH https://d774fe2b8f07493b.mokky.dev/items/1

{
  "price": 9999
}

В ответ получаем тот же объект, но уже с обновленной ценой:

{
  "id": 1,
  "title": "Мужские Кроссовки Nike Blazer Mid Suede",
  "price": 9999,
  "imageUrl": "/sneakers/sneakers-1.jpg"
}
PATCH /items Обновить / Очистить список товаров

С помощью PATCH-запроса можно не только обновить список товаров, но и сделать очиску.

К примеру, если вы хотите переписать один массив товаров на другой, можно использовать PATCH /items без передачи ID.

Или же, у вас задача по очистке корзины. Достаточно просто передать пустой массив.

PATCH /items

Payload: []
DELETE /items/1 Удаление товара

Достаточно просто передать DELETE-запрос с указанием ID объекта, который мы хотим удалить из ресурса.

В ответ сервер возвращает один из этих статусов:

Статус
Описание

200 OK

операция выполнилась успешно

404 Not found

товар не найден с таким ID

403 Forbidden

данный ресурс отключен или установлен запрет на его изменение

Более подробней ознакомиться со всеми возможностями можно в следующих разделах: , , , ,

📃
https://d774fe2b8f07493b.mokky.dev/items
Фильтрация
Сортировка
Пагинация
Выборка полей
Связь двух ресурсов