spenserca/serverless-api

An AWS API deployed with Serverless CLI

serverless-api

An AWS API deployed with Serverless CLI

Getting Started

1. Install Serverless CLI:
   • npm i -g serverless
2. Configure Serverless:
   • serverless
3. Optionally set up a Serverless account
4. Configure your AWS credentials
   • serverless config credentials --provider aws --key <aws_access_key> --secret <aws_access_key_secret>

Run Locally

1. Basic invoke
   • serverless invoke local --function <function_name>
2. Invoke with data
   • serverless invoke local --function <function_name> --path data.json

Deployment

1. Create the custom domain:
   • serverless create_domain --stage <stage_name> --profile <your_profile> --domainName <your_domain>
2. Package your code:
   • serverless package --stage <stage_name> --profile <your_profile> --domainName <your_domain>
3. Deploy your package:
   • serverless deploy --stage <stage_name> --profile <your_profile> --domainName <your_domain>
4. Test your endpoint:
   • curl https://<your_custom_domain>/demo/hello
   • curl https://<your_custom_domain>/demo/hello?name=<name>

Teardown

1. Tear down custom domain:
   • serverless delete_domain --stage <stage_name> --profile <your_profile> --domainName <your_domain>
2. Teardown Serverless resources
   • serverless remove --stage <stage_name> --profile <your_profile> --domainName <your_domain>

Enable Debug Mode for Serverless

In order to get more detailed logs when running Serverless commands export SLS_DEBUG=* environment variable