Перейти к основному содержимому

API

API ChurchApps — это модульный монолит: одна кодовая база, которая обслуживает шесть модулей данных, у каждого из которых своя база данных. Такая архитектура даёт организационные преимущества микросервисов (чёткие границы, независимые хранилища данных) при операционной простоте одного развёртывания.

Модули​

МодульНазначение
MembershipЛюди, группы, домохозяйства, права доступа
AttendanceСлужения, занятия, записи регистрации
ContentСтраницы, разделы, элементы, трансляции
GivingПожертвования, фонды, обработка платежей
MessagingБеседы, уведомления, email
DoingЗадачи, планы, назначения

Технологический стек​

  • Среда выполнения: Node.js 24.x с TypeScript (ES-модули)
  • Фреймворк: Express
  • Внедрение зависимостей: Inversify (маршрутизация на декораторах)
  • База данных: MySQL — по одной базе данных на модуль, у каждой свой пул соединений
  • Аутентификация: JWT через CustomAuthProvider
  • Развёртывание: AWS Lambda через Serverless Framework v3

Порты​

ПротоколПортОписание
HTTP8084Основной REST API
WebSocket8087Соединения сокетов в реальном времени

Функции Lambda​

При развёртывании в AWS API работает как шесть функций Lambda:

  • web — обрабатывает все HTTP-запросы
  • socket — управляет соединениями WebSocket
  • timer15Min — запускается каждые 30 минут для email-уведомлений (название исторически сложилось именно так)
  • timerMidnight — запускается ежедневно для дайджест-писем и служебных задач
  • timerScheduledTasks — запускается ежедневно для выполнения запланированных автоматизаций и обработки просроченных рабочих процессов
  • timerWebhooks — запускается каждую минуту для отправки исходящих вебхуков из очереди

Общие библиотеки​

API зависит от двух общих пакетов ChurchApps:

  • @churchapps/helpers — базовые утилиты (DateHelper, ApiHelper и др.)
  • @churchapps/apihelper — утилиты Express-сервера, включая аутентификацию, помощники работы с базой данных и интеграции с AWS
Информация

API использует ES-модули ("type": "module" в package.json). Убедитесь, что ваши импорты используют синтаксис ES-модулей.

В этом разделе​