Hoppa till huvudinnehål

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

Vad ingår​

  • CustomBaseController -- basklass för API-kontroller, byggd på inversify-express-utils
  • Auth -- JWT-autentisering via CustomAuthProvider, AuthenticatedUser och Principal
  • Databasverktyg -- DB.query / DB.queryOne och klassen Pool för hantering av MySQL-anslutningar, samt MySqlHelper och DBCreator för schemauppsättning
  • AWS-integrationer -- AwsHelper för S3-fillagring och läsning från SSM Parameter Store
  • E-post -- EmailHelper som stöder SES- och SMTP-transporter
  • Inläsning av konfiguration -- EnvironmentBase lä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:

  1. Klona arbetsytan:

    git clone https://github.com/ChurchApps/Packages.git
  2. Installera beroenden i arbetsytans rot:

    cd Packages && yarn install
  3. Bygg (kompilerar TypeScript till dist/):

    yarn workspace @churchapps/apihelper build

    Eller kör yarn build i 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.

info

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