Подготовила для вас практическое руководство по созданию полного JSON-объекта с примером из реальной жизни.
Полный дизайн JSON-объекта - это, как правило дизайн ответа для метода получения полной информации об одном объекте GET /object/{objectId} (пример: GET /books/{bookId}).
Создается первым, чтобы переиспользование его далее во всех запросах и ответах методов REST API.
То есть аналитика на самом деле делается не для одного метода REST API, а сразу для всех POST, GET, PATCH и других методов, нужных для управления данными об объекте.
Алгоритм:
➕0. Выделить список всех методов, где будет использован объект.
Результат: список методов POST, GET, PATCH и других для управления данных об одном объекте, для всех ролей пользователей.
Создается с использованием
CRUD-модели.
➕ 1. Составить список входных и выходных параметров для каждого метода.
Результат: Список параметров на русском или другом языке под каждый метод POST, GET, PATCH и другие.
➕ 2. Проверить по БД, что ничего не потеряли, и все нужные данные использованы.
Результат: Список параметров полного JSON-объекта может быть обновлен и дополнен. Иногда после этого шага дорабатывается БД.
➕ 3. Собрать JSON
Из сложного на этом этапе только понять, что лучше сделать вложенным объектом, что в массив, а что оставить в “плоском списке”.
🔗
Руководствопо JSON
тут
🔗
Как понимание БД помогает при создании JSON
🔗
Онлайн-валидатор JSON
Результат: Полный JSON-объект для дальнейшего использования в методах REST API.
➕ 4. Использовать результат для создания JSON запросов и ответов отдельных методов.
Детальный разбор шагов на реальном примере есть в книге к посту ☝️
#RestApiGA