За прошедший месяц в проекте FarmFreshGA мы спроектировали с нуля ключевые REST API методы:
✅ Поиск по каталогу продуктов (с кэшированием)
POST /products/search
Выгрузка требований из Confluence
✅ Редактирование товара для фермера
PUT /products/{productId}
Выгрузка требований из Confluence
✅ Создание заказа
POST /products
Финальная выгрузка из Confluence добавлена к этому посту.
На что стоит обратить внимание в этой базе документации:
👉 1. Использование метода POST как на создание, так и на получение данных. Хотя POST в REST предназначен только для создания.
👉 2. PUT на редактирование товара с обоснованием, почему мы всегда хотим отправлять на сервер полный набор параметров, а не только изменённые - что можно делать в PATCH.
👉 3. Наличие нескольких каталогов API на сервере:
+ Поиск продуктов - public
+ Редактирование и создание продуктов - seller-api
Обратите внимание на разницу в полных URL.
👉 4. Оформление требований к обработке ошибок.
👉 5. Алгоритм кэширования в поиске товаров по каталогу.
👉 6. Примеры требований к логированию и мониторигу.
👉 7. Наличие макетов UI и схемы БД, которые были необходимы для работы.
Эти документы — одновременно:
◽️ реальные примеры с проектов,
◽️ решения задач с собеседований на Senior СА (особенно метод поиска с кэшированием).
Проект #FarmFreshGA завершён! 🏁
Сохраняйте подборку в избранное, делитесь с коллегами, и следите за новостями о новых проектах! ❤️🔥
#RestApiGA