🔗 Как связаны JSON, UI и БД? С примером для #VetCareGA 🔗

Когда мы проектируем JSON для API запросов или ответов, важно понимать, что он не берётся «с потолка».

У него всегда есть два ориентира 👇


1️⃣ База данных (БД) — источник данных

👉 Показывает, какие параметры физически хранятся в системе

👉 У каждого JSON-объекта есть ключевая таблица (основной объект) и связанные по внешним ключам FK таблицы (доп. инфо).
Часто именно связанные таблицы в БД подсказывают структуру JSON:
▫️ один-к-одному → добавить вложенный объект {}
▫️ один-ко-многим → добавить массив объектов []

👉 Названия полей в БД помогают сделать названия в JSON, но не обязательно совпадают.

👉 Не все поля из БД попадают в JSON.

👉 А иногда наоборот — в JSON нужны поля, которых ещё нет в БД. Это повод доработать модель данных.

👉 А ещё бывают ситуации с полями для JSON вычисляемыми на лету. Например, в БД есть дата рождения, а на её основании надо рассчитать возраст и вернуть в JSON отдельным полем.



2️⃣ Клиент API — интерфейс (UI) или другая система

👉 Подсказывает, какие параметры надо включить в JSON.

👉 Именно клиент — главный источник требований к JSON. Что ему нужно — то и проектируем.
▫️ Если вы работаете над API для приложения с UI — смотрите на макет и проектируйте JSON от потребностей UI.
▫️ Если вы работаете над API для интеграции с вами партнера — смотрите требования от партнера и его UI, если есть.

👉 Клиенту обычно нужны и бизнес-данные, и технические параметры (id, статусы, ссылки)

👉 Форматы данных в JSON могут отличаться от того, как они представлены на UI (пример: дата и время)

👉 Картинки в JSON приходят в виде ссылок

👉 Не все поля JSON отображаются на UI. Главное, чтобы клиент получил всё, что ему нужно. А если JSON больше — это ок.


📌 Итого:
JSON проектируется не от БД и не от UI, а между ними.
Мы соединяем:
+ то, что можем взять из БД
+ с тем, что нужно отдать клиенту
= и формируем структуру, понятную для разработчиков и полезную для клиента API.


📄 В гайде к посту — пример JSON-ответа для метода:
Получение данных о записи питомца на приём

GET /appointments/{appointmentId}

Разберите его по частям:
1. какие поля есть в JSON и как они связаны с UI?
2. что есть в JSON по сравнению с БД, а чего нет?

Полная БД VetCareGA: ссылка


🟢🔖 Подход работает:
+ для любого метода, не только GET,
+ для JSON-ответа и для тела запроса


#RestApiGA

Telegram | VK | Max

🟢 [13 мая, 19:00 Мск] Как ИИ меняет работу аналитика: практика на задачах с REST API 🟢

ИИ уже меняет то, как работают аналитики. И те, кто разобрался — делают за час то, на что раньше уходил день.

Мы готовим практикум, где разберём это на реальных задачах с REST API.


Бесплатный онлайн-практикум:

⚡️ Как ИИ меняет работу аналитика: практика на задачах с REST API
🗓 13 мая, 19:00 Мск

🟢 Прямой эфир
с обратной связью для участников

🔗 Зарегистрироваться

План:
1. Основы REST API — что должен знать системный аналитик
2. Для каких задач аналитику нужен ИИ при работе с API
3. Обзор ИИ-инструментов: Qwen, ChatGPT, Claude и другие
4. Практика настройки ИИ-агента для работы с задачами на API
5. Погружение в REST API на практике через Postman и Insomnia
6. Документирование REST API через Swagger


За один вечер:
✅ Разберётесь, как ИИ ускоряет работу аналитика
✅ Поработаете с API-запросами в Postman и Insomnia
✅ Настроите ИИ-агента под свои задачи
✅ Получите основные навыки для работы со Swagger-документацией


Кому актуально:
▫️ Системным аналитикам — которые работают с API и хотят делать это быстрее и увереннее
▫️ Бизнес-аналитикам — которым нужно понимать интеграции и говорить с командой на одном языке
▫️ Начинающим аналитикам — которые хотят сразу работать с современными инструментами, а не догонять
▫️ Всем, кто устал делать руками то, что уже умеет делать ИИ



До встречи онлайн! 💜🩵


----—
P.S. Технические или организационные вопросы? Пишите @getanalyst или info@getanalyst.ru

📌📚 POST /appointments — пример постановки задачи на REST API метод — выгрузка из Confluence 🔵📋

Пополняю открытую базу знаний GetAnalyst.

Сделала новое полноценное ТЗ на разработку REST API метода "Запись питомца к ветеринару" для проекта #VetCareGA:

POST https://api.vetcarega.com/public/v1/appointments

Так что теперь у вас есть ещё один образец 🤝


Что внутри:
✅ авторизация и ограничения доступа
✅ 15 вариантов ответа с максимально точными HTTP-кодами (401, 403, 409, 422 ...)
✅ технический алгоритм работы Backend
✅ маппинг данных: запрос ↔ JSON ↔ БД
✅ логирование, метрики и алерты

🖥 Кликабельный прототип UI — можно потыкать, как выглядит экран пользователя, для которого метод

🗄 БД проекта



🕘 30 минут
ушло на постановку задачи с ИИ:
+ генерация
+ детальное ревью результатов и уточнения
+ перенос в Confluence


Работала со своим преднастроенным ИИ-агентом под задачи на REST API. Получилось очень быстро, минимум правок и высокое качество результата сразу.


🔖 Шаблон максимально полный
Забирайте себе, его можно адаптировать под любой метод вашего проекта.


#RestApiGA

📱 GetAnalyst | 💙 VK | 💬 Max

🔵 Задача на REST API с технического собеседования: где чаще всего ошибаются системные аналитики 📝🤝

Большинство системных аналитиков уверены, что знают REST API. Но на техническом собеседовании именно в этой задаче бывает больше всего ошибок.

Разбираем реальную задачу с собеседования: проектируем REST API метод для системы технической поддержки — от первого вопроса интервьюеру до обработки ошибок.

🔗 Статья с доп. материалами

После основного разбора — 20+ вопросов с подвохом: текстовый поиск, SQL-инъекции, оптимизация производительности, GET vs POST.

👉 Практика, которая прокачивает реальные навыки системного аналитика.


Видео с демо решения:
⏯ YouTube
⏯ RuTube
⏯ VK Video
⏯ Telegram

Аудио:
⏯ Apple Podcast
⏯ Яндекс.Музыка
⏯ Castbox
⏯ Звук
⏯ Spotify


🚀 GetAnalyst — техническая база системного аналитика


📱 Tg | 💙 ВК | 💬 Max