Naar hoofdinhoud gaan

API Deployment

ChurchApps API's worden geïmplementeerd als AWS Lambda-functies met behulp van het Serverless Framework. Deze pagina behandelt de bouw-, implementatie- en configuratieworkflow voor staging- en productieomgevingen.

Voordat u begint

  • Stel de API lokaal in -- zie Local API Setup
  • Configureer AWS-gegevens op uw machine
  • Zorg ervoor dat u toegang hebt tot het doel-AWS-account

Build​

API's worden voor productie gebouwd met behulp van een speciale TypeScript-configuratie:

npm run build:prod

Dit gebruikt tsconfig.prod.json om het project voor de Lambda-runtime te compileren.

Deploy​

Implementeer naar staging:

npm run deploy-staging

Implementeer naar productie:

npm run deploy-prod

Wat Wordt Aangemaakt​

Elke API-implementatie maakt of werkt de volgende AWS Lambda-functies bij:

FunctieDoel
webHTTP-verzoekhandler via API Gateway
socketWebSocket-verbindingshandler
timer15MinGeplande taak die elke 15 minuten draait
timerMidnightGeplande taak die dagelijks om middernacht draait

Omgevingsconfiguratie​

In geïmplementeerde omgevingen wordt configuratie gelezen uit AWS SSM Parameter Store in plaats van .env-bestanden. Dit houdt geheimen uit het implementatiepakket en maakt configuratiewijzigingen mogelijk zonder opnieuw in te dienen.

waarschuwing

Leg nooit productiegegevens vast in de repository. Alle gevoelige configuratie moet worden opgeslagen in AWS SSM Parameter Store en tijdens runtime worden geopend.

tip

Implementeer altijd eerst naar staging met behulp van npm run deploy-staging om de wijzigingen te verifiëren voordat u naar prod promoveert.

Gerelateerde Artikelen​