Ответы на эти вопросы помогут нам создать четкое представление о том, чего мы хотим достичь с помощью нашего api. Например, если создаем api для онлайн-магазина, можем определить следующие цели:
Увеличение продаж за счет улучшения пользовательского опыта
Уменьшение времени обработки заказов за счет автоматизации процессов
Улучшение безопасности данных за счет использования протокола HTTPS
Создание технического задания
После определения требований и целей мы можем создать техническое задание для нашего REST-api. Техническое должно включать в себя следующие элементы:
Описание требований и целей
Описание архитектуры и дизайна api
Описание протоколов и форматов данных
Описание системы безопасности и аутентификации
Техническое задание поможет нам создать четкое представление о том, что мы хотим достичь с помощью нашего api, и как будем это делать. В следующей главе рассмотрим, архитектуру дизайн REST-api.
2.2. Создание модели данных и ресурсов
В предыдущей главе мы познакомились с основными принципами REST-api и узнали, как они могут быть применены в реальных приложениях. Теперь давайте перейдем к более практическим аспектам создания рассмотрим, создать модель данных ресурсы, которые будут использоваться нашем api.
Модель данных: основа REST-api
Модель данных – это фундаментальная часть любого api, поскольку она определяет структуру и содержание данных, которые будут обрабатываться передаваться между клиентом сервером. В REST-api модель обычно представлена в виде ресурсов, могут быть созданы, прочитаны, обновлены удалены.
При создании модели данных необходимо учитывать следующие факторы:
Структура данных: Какие данные будут храниться и обрабатываться в нашем api? атрибуты свойства иметь эти данные?
Отношения между данными: Как данные будут связаны собой? Какие отношения существовать разными ресурсами?
Формат данных: В каком формате будут представлены данные? Будут ли они в виде JSON, XML или другого формата?
Ресурсы: основные строительные блоки REST-api
Ресурсы – это основные строительные блоки REST-api. Они представляют собой отдельные сущности, которые могут быть созданы, прочитаны, обновлены и удалены. представлены в виде отдельных объектов, коллекций объектов или даже действий, выполнены над объектами.
При создании ресурсов необходимо учитывать следующие факторы: