Nodejs eCommerce Shopping API that allows API consumers to interact with the application, behind the scene it uses Nodejs, Express and MongoDB, visit outset-v1.herokuapp.com/api/docs to see the API documentation. NodeJs - A JavaScript runtime environment to setup this project, run the following commands on your terminal 1. to clone the project `git clone //github.com/giftmbanda/nodejs-ecommerce-api`
2. navigate to the project directory `cd nodejs-ecommerce-api`
3. install neccesary packages, modules `npm install`
4. to run the project `npm start`
5. using POSTMAN you can use this default url of `//localhost:3000` I recommend that you use POSTMAN for testing this ecommerce api or you can hook it up to your front-end
application like Angular. Gift Bandanodejs-ecommerce-api
Dependecies
Express - A NodeJs framework
MongoDB - A NoSQL databaseSetup and run
Author
This full E-Commerce API build using Express and Mongo. Here it contains all the required functionalities of a full-fledged E-commerce API like User registration, User Login, Category Add, Edit & Delete, Product Add, Edit, Delete, Add product feature image & Add product images, Order creation and etc... $ git clone //github.com/dinushchathurya/nodejs-ecommerce-api.git
$ cd nodejs-ecommerce-api
$ npm install
POST | /api/v1/users/register POST | /api/v1/users/loginNode.js E-Commerce API
Setup
Run The Service
API Endpoints
User Routes
* Create User
KeyValue name
Admin
email
password
password
phone
+947187520
isAdmin
true
street
Main Street
apartment
Block C
zip
10870
city
Colombo
country
SriLanka
* Login User
password | password |
* Get Users
GET | /api/v1/users
* Get Single Users
GET | /api/v1/users/{id}
* Delete User
DELETE | /api/v1/users/{id}
* Get Users Count
GET | /api/v1/users/get/count
Category Routes
* Create Category
POST | /api/v1/categories
name | Category 1 |
icon | icon-health |
color | #55879 |
* Get Categories
GET | /api/v1/categories
* Get Single Category
GET | /api/v1/categories/{id}
* Update Category
PUT | /api/v1/categories/{id}
name | Category 1 |
icon | icon-health |
color | #55879 |
* Delete Category
DELETE | /api/v1/categories/{id}
Product Routes
* Create Product
POST | /api/v1/products
name | Product 1 |
description | Description |
richDescription | Rich Description |
image | image |
brand | Brand 1 |
price | 50 |
category | {category_id} |
countInStock | 100 |
rating | 4.5 |
numReviews | 40 |
isFeatured | true |
* Get Products
GET | /api/v1/products
* Get Single Category
GET | /api/v1/products/{id}
* Get Prodcut Counts
GET | /api/v1/products/get/count
* Get Featured Prodcut Counts
GET | /api/v1/products/get/featured/{count}
* Upload Galley Images
POST | /api/v1/products/gallery-images/{id}
images | Array of images |
* Update Product
PUT | /api/v1/products
name | Product 1 |
description | Description |
richDescription | Rich Description |
image | image |
brand | Brand 1 |
price | 50 |
category | {category_id} |
countInStock | 100 |
rating | 4.5 |
numReviews | 40 |
isFeatured | true |
* Delete Product
DELETE | /api/v1/products/{id}
Orders Routes
* Create Order
POST | /api/v1/orders
{ "orderItems":[ { "quantity": 3, "product" : "602e9c348e700335d8532b14" }, { "quantity": 2, "product" : "602bde0161fcc409fc149734" } ], "shippingAddress1" : "No 45,Park Street", "shippingAddress2" : "No 46,Main Street", "city" : "Colombo", "zip" : "10600t", "country" : "Sri Lanka", "phone" : "+94717185748", "user" : "602e9b718e700335d8532b13" }
* Get Orders
GET | /api/v1/orders
* Get Single Order
GET | /api/v1/orders/{id}
* Get Total Order Count
GET | /api/v1/orders/get/count
* Get Total Sales
GET | /api/v1/orders/get/totalsales
* Get User Order
GET | /api/v1/orders/get/usersorders/{userid}
* Update Single Order
PUT | /api/v1/orders/{id}
* Delete Single Order
DELETE | /api/v1/orders/{id}
Author
Dinush Chathurya
License
Copyright (c) 2020 Dinush Chathurya and codingtricks.io
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Blog
//codingtricks.io/