ApiHelper

Das @churchapps/apihelper-Package bietet Server-seitige Utilities für alle ChurchApps Express.js-APIs. Es enthält die Basis-Controller-Klasse, JWT-Authentifizierungs-Middleware, Datenbankus- hilfen und AWS-Integrationen, die jedes API-Projekt benötigt.

Vor dem Start

• Installieren Sie Node.js und Git — siehe Voraussetzungen
• Machen Sie sich mit dem npm link-Workflow für lokale Entwicklung vertraut
• Dieses Package hängt von @churchapps/helpers ab

Was ist enthalten

• CustomBaseController — Basis-Klasse für API-Controller
• Auth-Middleware — JWT-Authentifizierung via CustomAuthProvider
• Datenbankus- hilfen — DB.query, EnhancedPoolHelper für MySQL-Connection-Management
• AWS-Integrationen — Helfer für S3, SSM Parameter Store und andere AWS-Services
• Inversify DI-Setup — Dependency-Injection-Container-Konfiguration

Setup für lokale Entwicklung

1. Repository klonen:

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

2. Abhängigkeiten installieren:

   cd ApiHelper && npm install

3. Package bauen (kompiliert TypeScript zu dist/):

   npm run build

4. Verfügbar machen für lokales Linking:

   npm link

Wichtige Befehle

Befehl	Beschreibung
npm run build	TypeScript zu dist/ kompilieren
npm run lint	ESLint ausführen
npm run lint:fix	ESLint mit Auto-Fix ausführen
npm run format	Code mit Prettier formatieren

Info

Dieses Package ist eine Abhängigkeit jeder ChurchApps-API. Bei Änderungen, nutzen Sie npm link, um gegen eine API lokal zu testen, bevor Sie veröffentlichen.

Verwandte Artikel

• Helpers — Das Basis-Utility-Package, das dieses Package benötigt
• Modulstruktur — Wie Controller und Auth-Middleware in API-Modulen genutzt werden
• Lokales API-Setup — API für lokale Entwicklung einrichten