Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rookiemonkey/dummy-products-api

An api to fetch dummy e-commerce product :tshirt: :dress: :jeans: :womans_clothes: JSON data with placeholder images.
https://github.com/rookiemonkey/dummy-products-api

api dummy dummy-data dummy-products ecommerce expressjs fake fake-data fake-products javasript js nodejs product products

Last synced: about 1 month ago
JSON representation

An api to fetch dummy e-commerce product :tshirt: :dress: :jeans: :womans_clothes: JSON data with placeholder images.

Awesome Lists containing this project

README 

        

# DUMMY PRODUCTS REST API

![Made With](https://img.shields.io/badge/Made%20with-Node.JS-68A063?style=for-the-badge&logo=Node.JS)



This API aims to replicate the behaviour of various ecommerce website data and this is best for prototyping such kind of website. It provides dummy products with placeholder images with different sizes. I made this because I cannot find any api that can provide such dummy products, though there are some like ebay dev, however, its such as hassle to request an access and read through all the long documentation since all I need is a fake product as a placeholder. Faker js would do, however, I'm looking for something that matches at least the name of the product and its type/department. and here you go!



[Documentation](https://dummyproducts-api.herokuapp.com)



#### if you found this very useful, Please don't forget to star this repo! :tada: A rookie like me will highly appreaciate it



### FEATURES

* each dummy product has 3 dummy images (sizes 150x150, 300x300, 600x600) relative to product type (images used has CC license)

* each dummy product comes with description, prices, stock, ratings, and 5 reviews

* each dummy product query has an option to include similar products relative to its type or department

* with filters, you filter by ```stocks, sales, price, ratings``` with operators ```lt, gt, lte, gte``` (where in ```lt``` is 'less than', and ```lte``` 'less than or equal to', same pattern goes with ```gt``` & ```gte```)

	* filters will only work on ```/products``` and ```/products/search``` routes

* with search route, matches all product names depending on the query. You need to use query string keys ```term``` which will throw an error if not provided

* with pagination, you need to use query string keys ```page``` and ```limit```. You can use  both at the same time or one at a time

	* pagination (```page``` & ```limit```) can be used with all routes except ```/departments``` and ```/products/:product_id```

* with checkout, it only emulates the post request when buying something. nothing is inserted on the database but returns an object of the transaction



### SAMPLE

This is a dummy e-commerce website that consumes this API. This one is built using Vanilla JS wrapped with Typescript :tada: (just for experimentation)



You can visit the repo [here](https://github.com/rookiemonkey/dummy-ecommerce)

You can visit the website [here](https://krrb-prod-dummyecommerce.netlify.app/)



![Screenshot](./screenshots/dummyecommerce1.png)

![Screenshot](./screenshots/dummyecommerce2.png)

![Screenshot](./screenshots/dummyecommerce3.png)



### TO DO LIST (OPEN FOR CONTRIBUTIONS)

- dummy users

- dummy cart

- remove unnecessary routes to utilize query strings

- add dimensions property on Product Model?

- add discount property on Product Model?



### CONTRIBUTING GUIDELINES



Please check this [contributing guidlines](https://github.com/rookiemonkey/dummy-products-api/blob/dev/CONTRIBUTING.md)



### CONTRIBUTORS ✨



Thank you for all who contributed to this project!



	

		

			

			


Justin Balaguer

		

	



## Author: Kevin Roi R. Basina