Spring til hovedindhold

API-installation

ChurchApps API'er implementeres som AWS Lambda-funktioner ved hjælp af Serverless Framework. Denne side dækker build-, deploy- og konfigurationsworkflow for staging- og produktionsmiljøer.

Før du begynder

  • Opsætning af API lokalt -- se Lokalt API Setup
  • Konfigurér AWS-legitimationsoplysninger på din maskine
  • Sørg for, at du har adgang til AWS-kontoen for målet

Byg​

API'er bygges til produktion ved hjælp af en dedikeret TypeScript-konfiguration:

npm run build:prod

Dette bruger tsconfig.prod.json til at kompilere projektet til Lambda-kørtid.

Install​

Installer til staging:

npm run deploy-staging

Installer til produktion:

npm run deploy-prod

Hvad der skabes​

Hver API-installation opretter eller opdaterer følgende AWS Lambda-funktioner:

FunctionFormål
webHTTP-anmodningshandler via API Gateway
socketWebSocket-forbindelseshandler
timer15MinPlanlagt opgave, der køres hver 15. minut
timerMidnightPlanlagt opgave, der køres dagligt ved midnat

Miljøkonfiguration​

I implementerede miljøer læses konfigurationen fra AWS SSM Parameter Store i stedet for .env-filer. Dette holder hemmeligheder ud af installationspakken og tillader konfigurationsændringer uden at genimplementere.

advarsel

Commit aldrig produktionslegitimationsoplysninger til lageret. Al følsom konfiguration skal gemmes i AWS SSM Parameter Store og tilgås under kørtid.

tip

For at teste en installation uden at påvirke produktionen skal du altid installere til staging først ved hjælp af npm run deploy-staging og bekræfte ændringerne, før du promoverer til prod.

Relaterede artikler​