ApiHelper

Het @churchapps/apihelper-pakket biedt serverutilities voor alle ChurchApps Express.js API's. Het omvat de basiscontrollerklasse, JWT-verificatiemiddleware, databaseutilities en AWS-integraties waarvan elk API-project afhankelijk is.

Voordat u begint

• Installeer Node.js en Git -- zie Prerequisites
• Maak jezelf vertrouwd met de npm link workflow voor lokale ontwikkeling
• Dit pakket is afhankelijk van @churchapps/helpers

Wat Is Inbegrepen

• CustomBaseController -- basisklasse voor API-controllers
• Verificatiemiddleware -- JWT-verificatie via CustomAuthProvider
• Databaseutilities -- DB.query, EnhancedPoolHelper voor MySQL-verbindingsbeheer
• AWS-integraties -- helpers voor S3, SSM Parameter Store en andere AWS-services
• Inversify DI setup -- afhankelijkheidsinjectiecontainerconfiguratie

Setup voor Lokale Ontwikkeling

1. Kloon de repository:

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

2. Installeer afhankelijkheden:

   cd ApiHelper && npm install

3. Bouw het pakket (compileert TypeScript naar dist/):

   npm run build

4. Maak het beschikbaar voor lokaal koppelen:

   npm link

Sleutelcommando's

Command	Beschrijving
npm run build	Compileer TypeScript naar dist/
npm run lint	ESLint uitvoeren
npm run lint:fix	ESLint met auto-fix uitvoeren
npm run format	Code met Prettier opmaken

info

Dit pakket is een afhankelijkheid van elke ChurchApps API. Gebruik npm link bij het maken van wijzigingen om deze lokaal tegen een API te testen voordat u publiceert.

Gerelateerde Artikelen

• Helpers -- Het basisutiliteitspakket waarvan dit pakket afhankelijk is
• Module Structure -- Hoe controllers en verificatiemiddleware in API-modules worden gebruikt
• Local API Setup -- De API lokaal instellen voor ontwikkeling