This service provide simple HTTP API to get url preview with Node.js running on AWS Lambda and API Gateway using the Serverless Framework.
$ serverless deploy
After deploying, you should see output similar to:
Deploying aws-node-http-api-project to stage dev (us-east-1)
✔ Service deployed to stack aws-node-http-api-project-dev (152s)
endpoint: GET - https://xxxxxxxxxx.execute-api.us-east-1.amazonaws.com/
functions:
hello: aws-node-http-api-project-dev-hello (1.9 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 http event docs.
After successful deployment, you can call the created application via HTTP:
curl https://xxxxxxx.execute-api.us-east-1.amazonaws.com/
Which should result in response similar to the following (removed input
content for brevity):
{
"status": 200,
"data": {
"schema": {
// product schema object
},
"image": "string",
"meta": {
"parser": "string",
"modifiedDate": "date",
"createdDate": "date"
},
"name": "string",
"description": "string",
"sku": "string",
"url": "string"
}
}
You can invoke your function locally by using the following command:
serverless invoke local --function preview --data '{ "pathParameters": {"url":"aHR0cHM6Ly9hbXpuLmV1L2QvNzBPN2JMVQ=="}}'
url
is base64 encode string url of a product.
Which should result in response similar to the following:
{
"status": 200,
"data": {
"schema": {
"offers": {
"priceCurrency": "₹",
"@id": "B08TTPZ6MW",
"sku": "B08TTPZ6MW",
"offeredBy": "SRINIVASA Textiles",
"@type": "Offer",
"price": "309.00"
},
"image": "https://m.media-amazon.com/images/I/41b42TMM3SL._SX342_SY445_.jpg",
"@type": "Product",
"name": "Buy Amazon Brand - Eono Reusable Tote Bags | 100% Organic Cotton Shopping/Grocery Bag | Eco-Friendly Bag | Sturdy Canvas Bag with 15kgs Capacity | Pack of 2 | Life happens. Coffee helps & Salty but sweet at Amazon.in",
"description": "Buy Amazon Brand - Eono Reusable Tote Bags | 100% Organic Cotton Shopping/Grocery Bag | Eco-Friendly Bag | Sturdy Canvas Bag with 15kgs Capacity | Pack of 2 | Life happens. Coffee helps & Salty but sweet from Travel Tote Bags at Amazon.in. 30 days free exchange or return",
"category": "Shopping Bags & Baskets",
"sku": "B08TTPZ6MW",
"@context": "https://schema.org",
"brand": "Amazon Brand – Eono",
"url": "https://www.amazon.in/dp/B08TTPZ6MW?_encoding=UTF8&psc=1&ref_=cm_sw_r_cp_ud_dp_YS0GEB7DADQSW3JE4K0X"
},
"image": "https://m.media-amazon.com/images/I/41b42TMM3SL._SX342_SY445_.jpg",
"meta": {
"parser": "amazon",
"modifiedDate": "2022-08-17T12:24:45.760Z",
"createdDate": "2022-08-17T12:24:45.760Z"
},
"name": "Buy Amazon Brand - Eono Reusable Tote Bags | 100% Organic Cotton Shopping/Grocery Bag | Eco-Friendly Bag | Sturdy Canvas Bag with 15kgs Capacity | Pack of 2 | Life happens. Coffee helps & Salty but sweet at Amazon.in",
"description": "Buy Amazon Brand - Eono Reusable Tote Bags | 100% Organic Cotton Shopping/Grocery Bag | Eco-Friendly Bag | Sturdy Canvas Bag with 15kgs Capacity | Pack of 2 | Life happens. Coffee helps & Salty but sweet from Travel Tote Bags at Amazon.in. 30 days free exchange or return",
"sku": "B08TTPZ6MW",
"url": "https://www.amazon.in/dp/B08TTPZ6MW?_encoding=UTF8&psc=1&ref_=cm_sw_r_cp_ud_dp_YS0GEB7DADQSW3JE4K0X"
}
}
Alternatively, 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:
serverless plugin install -n serverless-offline
It will add the serverless-offline
plugin to devDependencies
in package.json
file as well as will add it to plugins
in serverless.yml
.
After installation, you can start local emulation with:
serverless offline start
To learn more about the capabilities of serverless-offline
, please refer to its GitHub repository.
npm install serverless-dynamodb-local
serverless dynamodb install
# (or to use a persistent docker dynamodb instead, open a new terminal: cd ./dynamodb && docker-compose up -d)
# (below 2 commands start offline and imports schema in local dynamodb)
serverless offline start
serverless dynamodb migrate
# (below start imports schema in local dynamodb only)
serverless dynamodb start --migrate
npm install -g dynamodb-admin
dynamodb-admin
- Convert model schema
./node_modules/.bin/typeconv -f ts -t oapi -o spec/models --oapi-format json 'src/models/*.ts'
- Generate schema
serverless openapi generate -o spec/openapi.json -f json -a 3.0.3