ApiHelper
Paketet @churchapps/apihelper innehåller serverside-verktyg för alla ChurchApps Express.js-API:er. Det omfattar basklassen för kontroller, JWT-autentisering, databasverktyg och AWS-integrationer som varje API-projekt är beroende av.
Innan du börjar
- Installera Node.js och Git -- se Förutsättningar
- Bekanta dig med Packages-arbetsytan och släppflödet
- Det här paketet är beroende av
@churchapps/helpers(som peer dependency) och exporterar om det
Vad ingår
- CustomBaseController -- basklass för API-kontroller, byggd på
inversify-express-utils - Auth -- JWT-autentisering via
CustomAuthProvider,AuthenticatedUserochPrincipal - Databasverktyg --
DB.query/DB.queryOneoch klassenPoolför hantering av MySQL-anslutningar, samtMySqlHelperochDBCreatorför schemauppsättning - AWS-integrationer --
AwsHelperför S3-fillagring och läsning från SSM Parameter Store - E-post --
EmailHelpersom stöder SES- och SMTP-transporter - Inläsning av konfiguration --
EnvironmentBaseläser anslutningssträngar och hemligheter från miljövariabler eller Parameter Store - Övrigt --
EncryptionHelper,FileStorageHelper,LoggingHelper,BasePermissions,SlugHelper
Konfiguration för lokal utveckling
Det här paketet finns i Packages-arbetsytan tillsammans med de andra delade biblioteken:
-
Klona arbetsytan:
git clone https://github.com/ChurchApps/Packages.git -
Installera beroenden i arbetsytans rot:
cd Packages && yarn install -
Bygg (kompilerar TypeScript till
dist/):yarn workspace @churchapps/apihelper buildEller kör
yarn buildi roten för att bygga alla paket i beroendeordning.
För att testa ändringar i ett API som använder paketet, använd en tillfällig Yarn-portal -- se Lokal utveckling mot en konsumerande app.
Publicering
Släpp går via changesets: kör yarn changeset i arbetsytans rot för varje ändring och sedan yarn publish-all när du är redo att släppa. Se Översikt över delade bibliotek för hela flödet.
Det här paketet är ett beroende för alla ChurchApps-API:er -- kärn-API:et Api, AskApi och LessonsApi. Testa mot ett API lokalt innan du publicerar när du gör ändringar.
Relaterade artiklar
- Helpers -- Baspaketet för verktyg som det här paketet är beroende av
- Modulstruktur -- Hur kontroller och auth-middleware används i API-moduler
- Lokal API-konfiguration -- Konfigurera API:et för lokal utveckling