ApiHelper

Пакет @churchapps/apihelper предоставляет серверные утилиты для всех Express.js API ChurchApps. Он включает базовый класс контроллера, middleware JWT-аутентификации, утилиты базы данных и интеграции с AWS, от которых зависит каждый API-проект.

Перед началом работы

• Установите Node.js и Git -- см. Предварительные требования
• Ознакомьтесь с процессом работы npm link для локальной разработки
• Этот пакет зависит от @churchapps/helpers

Что входит в пакет

• CustomBaseController -- базовый класс для API-контроллеров
• Middleware аутентификации -- JWT-аутентификация через CustomAuthProvider
• Утилиты базы данных -- DB.query, EnhancedPoolHelper для управления MySQL-соединениями
• Интеграции с AWS -- хелперы для S3, SSM Parameter Store и других сервисов AWS
• Настройка Inversify DI -- конфигурация контейнера внедрения зависимостей

Настройка для локальной разработки

1. Клонируйте репозиторий:

   git clone https://github.com/ChurchApps/ApiHelper.git

2. Установите зависимости:

   cd ApiHelper && npm install

3. Соберите пакет (компилирует TypeScript в dist/):

   npm run build

4. Сделайте его доступным для локального связывания:

   npm link

Основные команды

Команда	Описание
npm run build	Компиляция TypeScript в dist/
npm run lint	Запуск ESLint
npm run lint:fix	Запуск ESLint с автоисправлением
npm run format	Форматирование кода с Prettier

Информация

Этот пакет является зависимостью каждого API ChurchApps. При внесении изменений используйте npm link для тестирования с API локально перед публикацией.

Связанные статьи

• Helpers -- Базовый пакет утилит, от которого зависит этот пакет
• Структура модулей -- Как контроллеры и middleware аутентификации используются в модулях API
• Локальная настройка API -- Настройка API для локальной разработки