Practice API specification
This section provided you the instruction to run the development API locally using nodejs or docker. You may consider using JSON Sever.
Prerequisite:
-
nest cli / any web server
-
Docker (recommended)
-
To run the API locally, please install docker and run the following command:
docker-compose up -d
Install: yarn
API Usage
- Endpoint: http://localhost:4001/
- Swagger: http://localhost:4001/api
Functionality (for v2):
End user app:
-
Homepage
- Trendy collection
-
Products
- Get list products
- Get list discount products
- Products search & filtering
- Get product details:
- Photo list
- Summary info
- Details info:
- Perspective: product perspective gallery
- Get related products
-
Cart
- Cart items
- Purchase history
- Checkout
-
Categories
- Get all category
-
Gallery
- Get list image gallery
-
Blogs
- Blogs
- Blogs Categories
- Recently Blogs
-
About us: timeline/static page
-
Support
- Mailing
-
Utils
- Menu
- Address
- Login/register
- Authorization
Admin page:
-
Homepage
- Create/Edit/Delete Trendy collection
-
Products
- Create/Edit/Delete product
-
Cart
- Purchase history
- Statistic
-
Categories
- Create/Edit/Delete Category
-
Gallery
- Create/Edit/Delete image in gallery
-
Blogs
- Create/Edit/Delete Blog
- Create/Edit/Delete Blogs Categories
-
About us:
-
Support
- Mailing list
-
Utils
- Create/Edit/Delete Menu
- Login/register
- Account list
- Authorization