Системный модуль Webservice

Модуль webservice отвечает за публикацию API/REST интерфейсов системы.

Назначение

• маршрутизация и обработка API-запросов;
• работа с версиями API;
• интеграция со схемами/документацией OpenAPI.

Базовые принципы

• Разделяйте API по версиям.
• Стабилизируйте контракты (не ломайте ответы без новой версии).
• Для ошибок используйте единый формат ответа и корректные HTTP-коды.

Практика

• Бизнес-логику держите в классах/моделях модуля, а не в API-контроллере.
• Проверяйте аутентификацию и авторизацию на уровне каждого ресурса.
• Для публичных методов обязательно описывайте маршруты и схемы в OpenAPI.