Hello Friends, In my quest to learn and keep updating my self. I have written a small Node.js token based demo project for the sample pizza delivery app. The code is written in Core Node.js. I haven’t used any npm modules.
The project can be used as a sample or reference application for making your own API in Node.js. Please note that there is no UI for the project. And these are only bare metal API’s.
I have integrated this project with Stripe to have a payment module. . Moreover the API is also integrated with mailgun to deliver the receipt of the purchase to user at their email.
Prerequisites for the Project:
You need to have below requirements to understand and implement the project at your end.
- Basic JavaScript knowledge to understand the Node.js.
- Latest stable version of Node.js installed on the System.
- Developer account for MailGun and Stripe API. Replace your own API key in the lib/Config.js file.
- I am not using any DB to store the user and token. They are stored in the flat files on the system.
- Http client like Postman to test the APIs.
- Download the code from GitHub link: https://github.com/vikramvee/Pizza-Delivery-API-Using-Core-NodeJS
Functionalities or API developed in the Project:
The project help us to achieve below functionalities or API.
- Add, update, delete and get a user from the system.
- Login and Logout of the user.
- Token generation for the logged in user so that password is not required for every transaction.
- Add items to the cart. For Example Coke, Small Pizza, Medium Pizza etc.
- Checkout and place the order.
- Logout and delete the token.
Exposed Http APIs
API Name \users:
Methods:
GET: Gets the users details created in the application. email should be provided in the QueryString for the user and ‘token’ in the header.
PUT: The method is used to update the details of the user. You can update firstName, lastName, and password. The email is the mandatory field for the update.
POST : The method is used to add a user to the system. The data should be sent to the method call as payload. Below is the format of the data which should be passed in the payload of the method call.
{
"firstName": "Vikram",
"lastName": "Chaudhary",
"streetAddress": "#1 9th Cross",
"password": "test123",
"email": "vikram@test.com"
}DELETE: The method is used to delete the user from the system. The user can be deleted by providing the email as
query string and password in the header fields.
API \login:
Methods:
POST: Only http post is valid for this API.
The user can login to the app to order the pizza. The user has to provide the email and password in the payload of the
POST request. The format should be as below.
{
"email" : "vikram@test.com",
"password" : "test123"
}Once the user successfully logs in the system. He will get the menu items as well as the token valid for next 1 hour.
The response will be in below format.
{
"data": {
"email": "vikram@test.com",
"id": "6c7whoy15xz094vsjz1d",
"expires": 1538997627637
},
"menuItems": {
"Pizza": {
"Name": "LargePizza",
"UnitPrice": 80
},
"SmallPizza": {
"Name": "SmallPizza",
"UnitPrice": 40
},
"MediumPizza": {
"Name": "MediumPizza",
"UnitPrice": 60
},
"Coke": {
"Name": "Coke",
"UnitPrice": 40
},
"Pepsi": {
"Name": "Pepsi",
"UnitPrice": 40
}
}
}API \items:
Methods:
POST:
Only post method is valid for this API. Send the email and item to be added to the cart in the query string as shown below.
http://localhost:3000/items?email=vikram@test.com&item=LargePizza
And the token should be sent as part of the header.
If you are successfully able to add the item you should get the response from the API as shown below
{
"cart": [
{
"Name": "LargePizza",
"UnitPrice": 80
}
]
}In the next API call to add other item, the above content should be part of the payload with other item.
API : http://localhost:3000/items?email=vikram@test.com&item=Coke
Payload:
{
"cart": [
{
"Name": "LargePizza",
"UnitPrice": 80
}
]
}And the response would be:
{
"cart": [
{
"Name": "LargePizza",
"UnitPrice": 80
},
{
"Name": "Coke",
"UnitPrice": 40
}
]
}API /checkout
Methods:
POST:
The method is used to make the payment for all the selected items to the Stripe gateway.
Mandatory is the email in querystringobject and token in the header.
http://localhost:3000/checkout?email=vikram@chaudhary.com
And payload of all the items as shown below.
{
"cart": [
{
"Name": "LargePizza",
"UnitPrice": 80
},
{
"Name": "Coke",
"UnitPrice": 40
}
]
}Once the payload is successful we will send the receipt to the user using the provided user email by mailgun API.
API /logout:
Methods:
GET: Once you are done with the ordering and payment for your orders. You can logout from the application. You need to provide the email in the query string and token in the header.
The query string will look like as below:
http://localhost:3000/checkout?email=vikram@chaudhary.com
On successful completion of the logout you should get 200 as the status code.
Starting up the Project and Sample Steps
In this section I will show you how to start the project and some sample steps to work on it.
- First of all to start the project go to the folder where you have downloaded the code. Now open the folder in the command prompt or terminal. And run the below command
node init.js
And you will get the output as “Server is running on port 3000”.
- Next open the postman Http client on your system. And send a POST request to Node.js server to create a user.
And you will notice a user is created in json file in the data > users folder.
Running the Project on Windows.
On the github link, the project uploaded is working on Linux. To make it run successfully we need to do small changes.
In the lib folder, you can see a Data.js file. Open the file and replace all the occurrences of below line,
var fileName = lib.baseDir+dir+’/’+file+’.json’;
with
var fileName = lib.baseDir + ‘\\’ + dir + ‘\\’ + file + ‘.json’;
And you are good to run the project on Windows.
Conclusion:
This project can help you to understand and develop you own Web API project in Node.js. The project will help you to understand the routing mechanism, file handling, Http server class handling to name a few.