ApiHelper

@churchapps/apihelper-pakken tilbyr serversideverktøy for alle ChurchApps Express.js-API-er. Den inkluderer basekontrollerklassen, JWT-autentiseringsmellomvare, databaseverktøy og AWS-integrasjoner som hvert API-prosjekt er avhengig av.

Før du begynner

• Installer Node.js og Git -- se Forutsetninger
• Gjør deg kjent med npm link-arbeidsflyten for lokal utvikling
• Denne pakken avhenger av @churchapps/helpers

Hva er inkludert

• CustomBaseController -- baseklasse for API-kontrollere
• Autentiseringsmellomvare -- JWT-autentisering via CustomAuthProvider
• Databaseverktøy -- DB.query, EnhancedPoolHelper for MySQL-tilkoblingsadministrasjon
• AWS-integrasjoner -- hjelpere for S3, SSM Parameter Store og andre AWS-tjenester
• Inversify DI-oppsett -- konfigurasjon av avhengighetsinjeksjonsbeholder

Oppsett for lokal utvikling

1. Klon repositoriet:

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

2. Installer avhengigheter:

   cd ApiHelper && npm install

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

   npm run build

4. Gjør den tilgjengelig for lokal lenking:

   npm link

Viktige kommandoer

Kommando	Beskrivelse
npm run build	Kompiler TypeScript til dist/
npm run lint	Kjør ESLint
npm run lint:fix	Kjør ESLint med automatisk retting
npm run format	Formater kode med Prettier

Info

Denne pakken er en avhengighet for hvert ChurchApps API. Når du gjør endringer, bruk npm link for å teste mot et API lokalt før publisering.

Relaterte artikler

• Helpers -- Basisverktøy-pakken som denne pakken avhenger av
• Modulstruktur -- Hvordan kontrollere og autentiseringsmellomvare brukes i API-moduler
• Lokalt API-oppsett -- Sette opp API-et for lokal utvikling