ApiHelper

@churchapps/apihelper-pakken giver serversidesværktøjer til alle ChurchApps Express.js-API'er. Den inkluderer basiscontrollerklassen, JWT-godkendelsesmiddelware, databaseværktøjer og AWS-integrationer, som alle API-projekter afhænger af.

Før du begynder

• Installer Node.js og Git -- se Forudsætninger
• Gør dig bekendt med npm link workflow til lokal udvikling
• Denne pakke afhænger af @churchapps/helpers

Hvad er inkluderet

• CustomBaseController -- basisklasse til API-controllere
• Auth middleware -- JWT-godkendelse via CustomAuthProvider
• Databaseværktøjer -- DB.query, EnhancedPoolHelper til MySQL-forbindelsesstyringsadministration
• AWS-integrationer -- hjælpere til S3, SSM Parameter Store og andre AWS-tjenester
• Inversify DI-setup -- dependency injection-containerberegning

Setup til lokal udvikling

1. Klon lageret:

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

2. Installer afhængigheder:

   cd ApiHelper && npm install

3. Byg pakken (kompilerer TypeScript til dist/):

   npm run build

4. Gør det tilgængeligt til lokal linking:

   npm link

Vigtige kommandoer

Command	Beskrivelse
npm run build	Kompilér TypeScript til dist/
npm run lint	Kør ESLint
npm run lint:fix	Kør ESLint med auto-fix
npm run format	Formater kode med Prettier

info

Denne pakke er en afhængighed af hver ChurchApps API. Når du foretager ændringer, skal du bruge npm link til at teste mod en API lokalt, før du udgiver.

Relaterede artikler

• Helpers -- Det grundlæggende værktøjspakke, som denne pakke afhænger af
• Modulstruktur -- Hvordan controllere og auth middleware bruges i API-moduler
• Lokalt API-setup -- Opsætning af API'en til lokal udvikling