Highlights

• Versioned API : Request and response versioning for all API endpoints.
• Metrics : Cloudwatch metrics for API endpoint performance and health monitoring.
• OpenAPI Spec : Full API documentation and benefit of OpenAPI.
• SwaggerUI Static Site : A basic static site deployment hosting SwaggerUI and the API spec.
• DynamoDB Toolbox : Lightweight and type-safe query builder for DynamoDB.
• Authorization : API key authorization.

API Spec

Setup

Requirements

• Node 20
• AWS CLI and credentials configured

Getting Started

Install node packages

npm i

Setup API_KEY secret

Each deployed stage will require a secret API_KEY created to allow access to the API. (This authentication solution is not intended for production purposes and should be improved for any serious deployments.)

Run the following command and supply the API key value for <your-key-here>:

npm run secrets:set API_KEY <your-key-here>

Testing

Deployment

By default a local stage is built for development purposes, using the npm run dev command will launch the application. SST connects from the AWS cloud to your local machine to use local code and provide a realtime development experience while resources are hosted in the cloud.

Manually deploy production

# Make sure you have set an API_KEY for production one time
npm run secrets:set API_KEY <your-key-here> -- --stage production

Deploy the stack

npm run deploy -- --stage production