updating onboarding AWS node examples

Author: skierkowski

aws-node-express-api/README.md

@@ -1,23 +1,21 @@
 <!--
 title: 'Serverless Framework Node Express API on AWS'
-description: 'This template demonstrates how to develop and deploy a simple Node Express API running on AWS Lambda using the traditional Serverless Framework.'
+description: 'This template demonstrates how to develop and deploy a simple Node Express API running on AWS Lambda using the Serverless Framework.'
 layout: Doc
-framework: v2
+framework: v4
 platform: AWS
 language: nodeJS
 priority: 1
 authorLink: 'https://github.com/serverless'
-authorName: 'Serverless, inc.'
+authorName: 'Serverless, Inc.'
 authorAvatar: 'https://avatars1.githubusercontent.com/u/13742415?s=200&v=4'
 -->
 
 # Serverless Framework Node Express API on AWS
 
-This template demonstrates how to develop and deploy a simple Node Express API service running on AWS Lambda using the traditional Serverless Framework.
+This template demonstrates how to develop and deploy a simple Node Express API service running on AWS Lambda using the Serverless Framework.
 
-## Anatomy of the template
-
-This template configures a single function, `api`, which is responsible for handling all incoming requests thanks to the `httpApi` event. To learn more about `httpApi` event configuration options, please refer to [httpApi event docs](https://www.serverless.com/framework/docs/providers/aws/events/http-api/). As the event is configured in a way to accept all incoming requests, `express` framework is responsible for routing and handling requests internally. Implementation takes advantage of `serverless-http` package, which allows you to wrap existing `express` applications. To learn more about `serverless-http`, please refer to corresponding [GitHub repository](https://github.com/dougmoscrop/serverless-http).
+This template configures a single function, `api`, which is responsible for handling all incoming requests using the `httpApi` event. To learn more about `httpApi` event configuration options, please refer to [httpApi event docs](https://www.serverless.com/framework/docs/providers/aws/events/http-api/). As the event is configured in a way to accept all incoming requests, the Express.js framework is responsible for routing and handling requests internally. This implementation uses the `serverless-http` package to transform the incoming event request payloads to payloads compatible with Express.js. To learn more about `serverless-http`, please refer to corresponding [GitHub repository](https://github.com/dougmoscrop/serverless-http).
 
 ## Usage
 
@@ -38,34 +36,13 @@ serverless deploy
 After running deploy, you should see output similar to:
 
 ```bash
-Serverless: Packaging service...
-Serverless: Excluding development dependencies...
-Serverless: Creating Stack...
-Serverless: Checking Stack create progress...
-........
-Serverless: Stack create finished...
-Serverless: Uploading CloudFormation file to S3...
-Serverless: Uploading artifacts...
-Serverless: Uploading service aws-node-express-api.zip file to S3 (711.23 KB)...
-Serverless: Validating template...
-Serverless: Updating Stack...
-Serverless: Checking Stack update progress...
-.................................
-Serverless: Stack update finished...
-Service Information
-service: aws-node-express-api
-stage: dev
-region: us-east-1
-stack: aws-node-express-api-dev
-resources: 12
-api keys:
-  None
-endpoints:
-  ANY - https://xxxxxxx.execute-api.us-east-1.amazonaws.com/
+Deploying "aws-node-express-api" to stage "dev" (us-east-1)
+
+✔ Service deployed to stack aws-node-express-api-dev (96s)
+
+endpoint: ANY - https://al7bkh7f57.execute-api.us-east-1.amazonaws.com
 functions:
-  api: aws-node-express-api-dev-api
-layers:
-  None
+  api: aws-node-express-api-dev-api (2.3 kB)
 ```
 
 _Note_: In current form, after deployment, your API is public and can be invoked by anyone. For production deployments, you might want to configure an authorizer. For details on how to do that, refer to [`httpApi` event docs](https://www.serverless.com/framework/docs/providers/aws/events/http-api/).
@@ -80,48 +57,40 @@ curl https://xxxxxxx.execute-api.us-east-1.amazonaws.com/
 
 Which should result in the following response:
 
-```
-{"message":"Hello from root!"}
+```json
+{ "message": "Hello from root!" }
 ```
 
 Calling the `/hello` path with:
 
-```bash
+```
 curl https://xxxxxxx.execute-api.us-east-1.amazonaws.com/hello
 ```
 
 Should result in the following response:
 
-```bash
-{"message":"Hello from path!"}
-```
-
-If you try to invoke a path or method that does not have a configured handler, e.g. with:
-
-```bash
-curl https://xxxxxxx.execute-api.us-east-1.amazonaws.com/nonexistent
-```
-
-You should receive the following response:
-
-```bash
-{"error":"Not Found"}
+```json
+{ "message": "Hello from path!" }
 ```
 
 ### Local development
 
-It is also possible to emulate API Gateway and Lambda locally by using `serverless-offline` plugin. In order to do that, execute the following command:
+The easiest way to develop and test your function is to use the `dev` command:
 
-```bash
-serverless plugin install -n serverless-offline
+```
+serverless dev
 ```
 
-It will add the `serverless-offline` plugin to `devDependencies` in `package.json` file as well as will add it to `plugins` in `serverless.yml`.
+This will start a local emulator of AWS Lambda and tunnel your requests to and from AWS Lambda, allowing you to interact with your function as if it were running in the cloud.
 
-After installation, you can start local emulation with:
+In another terminal you can invoke your function by using the following command:
 
 ```
-serverless offline
+curl https://xxxxxxx.execute-api.us-east-1.amazonaws.com/hello
 ```
 
-To learn more about the capabilities of `serverless-offline`, please refer to its [GitHub repository](https://github.com/dherault/serverless-offline).
+Which should result in response similar to the following:
+
+```json
+{ "message": "Hello from path!" }
+```

aws-node-express-api/package.json

@@ -3,7 +3,7 @@
   "version": "1.0.0",
   "description": "",
   "dependencies": {
-    "express": "^4.18.2",
+    "express": "^4.19.2",
     "serverless-http": "^3.2.0"
   }
 }

aws-node-express-api/serverless.template.yml

@@ -1,11 +1,13 @@
 service: aws-node-express-api
-frameworkVersion: '4'
+
+frameworkVersion: "4"
 
 provider:
   name: aws
   runtime: nodejs20.x
+
 functions:
   api:
     handler: handler.handler
     events:
-      - httpApi: '*'
+      - httpApi: "*"

aws-node-express-api/serverless.yml

@@ -1,24 +1,23 @@
 <!--
 title: 'Serverless Framework Node Express API service backed by DynamoDB on AWS'
-description: 'This template demonstrates how to develop and deploy a simple Node Express API service backed by DynamoDB running on AWS Lambda using the traditional Serverless Framework.'
+description: 'This template demonstrates how to develop and deploy a simple Node Express API service backed by DynamoDB running on AWS Lambda using the Serverless Framework.'
 layout: Doc
 framework: v2
 platform: AWS
 language: nodeJS
 priority: 1
 authorLink: 'https://github.com/serverless'
-authorName: 'Serverless, inc.'
+authorName: 'Serverless, Inc.'
 authorAvatar: 'https://avatars1.githubusercontent.com/u/13742415?s=200&v=4'
 -->
 
 # Serverless Framework Node Express API on AWS
 
-This template demonstrates how to develop and deploy a simple Node Express API service, backed by DynamoDB database, running on AWS Lambda using the traditional Serverless Framework.
+This template demonstrates how to develop and deploy a simple Node Express API service, backed by DynamoDB table, running on AWS Lambda using the Serverless Framework.
 
+This template configures a single function, `api`, which is responsible for handling all incoming requests using the `httpApi` event. To learn more about `httpApi` event configuration options, please refer to [httpApi event docs](https://www.serverless.com/framework/docs/providers/aws/events/http-api/). As the event is configured in a way to accept all incoming requests, the Express.js framework is responsible for routing and handling requests internally. This implementation uses the `serverless-http` package to transform the incoming event request payloads to payloads compatible with Express.js. To learn more about `serverless-http`, please refer to corresponding [GitHub repository](https://github.com/dougmoscrop/serverless-http).
 
-## Anatomy of the template
-
-This template configures a single function, `api`, which is responsible for handling all incoming requests thanks to the `httpApi` event. To learn more about `httpApi` event configuration options, please refer to [httpApi event docs](https://www.serverless.com/framework/docs/providers/aws/events/http-api/). As the event is configured in a way to accept all incoming requests, `express` framework is responsible for routing and handling requests internally. Implementation takes advantage of `serverless-http` package, which allows you to wrap existing `express` applications. To learn more about `serverless-http`, please refer to corresponding [GitHub repository](https://github.com/dougmoscrop/serverless-http). Additionally, it also handles provisioning of a DynamoDB database that is used for storing data about users. The `express` application exposes two endpoints, `POST /users` and `GET /user/{userId}`, which allow to create and retrieve users.
+Additionally, it also handles provisioning of a DynamoDB database that is used for storing data about users. The Express.js application exposes two endpoints, `POST /users` and `GET /user/:userId`, which create and retrieve a user record.
 
 ## Usage
 
@@ -38,35 +37,14 @@ serverless deploy
 
 After running deploy, you should see output similar to:
 
-```bash
-Serverless: Packaging service...
-Serverless: Excluding development dependencies...
-Serverless: Creating Stack...
-Serverless: Checking Stack create progress...
-........
-Serverless: Stack create finished...
-Serverless: Uploading CloudFormation file to S3...
-Serverless: Uploading artifacts...
-Serverless: Uploading service aws-node-express-dynamodb-api.zip file to S3 (718.53 KB)...
-Serverless: Validating template...
-Serverless: Updating Stack...
-Serverless: Checking Stack update progress...
-....................................
-Serverless: Stack update finished...
-Service Information
-service: aws-node-express-dynamodb-api
-stage: dev
-region: us-east-1
-stack: aws-node-express-dynamodb-api-dev
-resources: 13
-api keys:
-  None
-endpoints:
-  ANY - https://xxxxxxx.execute-api.us-east-1.amazonaws.com/
+```
+Deploying "aws-node-express-dynamodb-api" to stage "dev" (us-east-1)
+
+✔ Service deployed to stack aws-node-express-dynamodb-api-dev (109s)
+
+endpoint: ANY - https://jhssgx6g93.execute-api.us-east-1.amazonaws.com
 functions:
-  api: aws-node-express-dynamodb-api-dev-api
-layers:
-  None
+  api: aws-node-express-dynamodb-api-dev-api (3.8 MB)
 ```
 
 _Note_: In current form, after deployment, your API is public and can be invoked by anyone. For production deployments, you might want to configure an authorizer. For details on how to do that, refer to [`httpApi` event docs](https://www.serverless.com/framework/docs/providers/aws/events/http-api/). Additionally, in current configuration, the DynamoDB table will be removed when running `serverless remove`. To retain the DynamoDB table even after removal of the stack, add `DeletionPolicy: Retain` to its resource definition.
@@ -75,86 +53,46 @@ _Note_: In current form, after deployment, your API is public and can be invoked
 
 After successful deployment, you can create a new user by calling the corresponding endpoint:
 
-```bash
+```
 curl --request POST 'https://xxxxxx.execute-api.us-east-1.amazonaws.com/users' --header 'Content-Type: application/json' --data-raw '{"name": "John", "userId": "someUserId"}'
 ```
 
 Which should result in the following response:
 
-```bash
-{"userId":"someUserId","name":"John"}
+```json
+{ "userId": "someUserId", "name": "John" }
 ```
 
 You can later retrieve the user by `userId` by calling the following endpoint:
 
-```bash
+```
 curl https://xxxxxxx.execute-api.us-east-1.amazonaws.com/users/someUserId
 ```
 
 Which should result in the following response:
 
-```bash
-{"userId":"someUserId","name":"John"}
-```
-
-If you try to retrieve user that does not exist, you should receive the following response:
-
-```bash
-{"error":"Could not find user with provided \"userId\""}
+```json
+{ "userId": "someUserId", "name": "John" }
 ```
 
 ### Local development
 
-It is also possible to emulate DynamoDB, API Gateway and Lambda locally using the `serverless-dynamodb-local` and `serverless-offline` plugins. In order to do that, run:
+The easiest way to develop and test your function is to use the `dev` command:
 
-```bash
-serverless plugin install -n serverless-dynamodb-local
-serverless plugin install -n serverless-offline
 ```
-
-It will add both plugins to `devDependencies` in `package.json` file as well as will add it to `plugins` in `serverless.yml`. Make sure that `serverless-offline` is listed as last plugin in `plugins` section:
-
-```
-plugins:
-  - serverless-dynamodb-local
-  - serverless-offline
+serverless dev
 ```
 
-You should also add the following config to `custom` section in `serverless.yml`:
-
-```
-custom:
-  (...)
-  dynamodb:
-    start:
-      migrate: true
-    stages:
-      - dev
-```
+This will start a local emulator of AWS Lambda and tunnel your requests to and from AWS Lambda, allowing you to interact with your function as if it were running in the cloud.
 
-Additionally, we need to reconfigure `AWS.DynamoDB.DocumentClient` to connect to our local instance of DynamoDB. We can take advantage of `IS_OFFLINE` environment variable set by `serverless-offline` plugin and replace:
+In another terminal you can invoke your function by using the following command:
 
-```javascript
-const dynamoDbClient = new AWS.DynamoDB.DocumentClient();
 ```
-
-with the following:
-
-```javascript
-const dynamoDbClientParams = {};
-if (process.env.IS_OFFLINE) {
-  dynamoDbClientParams.region = 'localhost'
-  dynamoDbClientParams.endpoint = 'http://localhost:8000'
-}
-const dynamoDbClient = new AWS.DynamoDB.DocumentClient(dynamoDbClientParams);
+curl https://xxxxxxx.execute-api.us-east-1.amazonaws.com/users/someUserId
 ```
 
-After that, running the following command with start both local API Gateway emulator as well as local instance of emulated DynamoDB:
+Which should result in response similar to the following:
 
-```bash
-serverless offline start
+```json
+{ "userId": "someUserId", "name": "John" }
 ```
-
-To learn more about the capabilities of `serverless-offline` and `serverless-dynamodb-local`, please refer to their corresponding GitHub repositories:
-- https://github.com/dherault/serverless-offline
-- https://github.com/99x/serverless-dynamodb-local