💎 Методы REST API: 9 примеров для понимания принципов дизайна REST API 💎

Для проекта #ElibraGA спроектировала методы, которые надо реализовать для обеспечения работы приложения.


На что обращать внимание при знакомстве с документом:


Методы REST API - для приложения читателя

✔️ Получить список книг
Показаны:
+ Работа с Query-параметрами для пагинации и фильтрации.
+ Показан массив - список книг.
+ Структура списка - его всегда лучше держать внутри {}, даже если не будет элементов пагинации limit, offset, count.

✔️ Получить информацию о выбранной книге
Пример URL получения информации о конкретном объекте из списка по его id.

✔️ Получить список избранных книг пользователя
Обратите внимание на структуру URL и уточнение про авторизацию пользователя.

✔️ Получить информацию о пользователе и его текущей подписке
+ Проанализируйте JSON с информацией о пользователе и его связь с БД.
аналогично проанализируйте JSON метода получения информации о книге по id и его связь с БД.
Какие особенности заметили?
+ Также для пользователя и книги проверьте, что есть в JSON, и чего нет на UI.


Методы REST API - для приложения админа

✔️ Загрузить обложку книги + Загрузить файл книги
Помогут понять, как работать с загрузкой файлов при работе с REST API.
Важно:
1. Сначала грузим файлы в хранилище.
2. Потом создаём книги с использованием готовых ссылок.

✔️ Создать книгу
Обратите внимание, что JSON-запроса по структуре отличается от JSON-ответа.
Например, при создании книги не надо передавать всю информацию об авторе, т.к. подразумеваем, что его уже создали в системе до этого запроса. Нужен только id.

✔️ Редактировать книгу
Вариантов JSON-запроса может быть много.
В ответ рекомендуется всегда возвращать полный JSON-объекта при редактировании. Допустимы другие варианты.

✔️ Удалить (архивировать) книгу
Нет JSON-ов.


Документ разработана в Confluence.


👉 Методы этого проекта будут особенно полезны для систем, в которых предусматривается работа с файлами.

Сохраняем в личные архивы 🤝

#RestApiGA