Skip to content
/ local-crafts-backend Public

RESTful API for products & services market place with Nest framework.

1 star 2 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

AhmedEhab-SG/local-crafts-backend

BranchesTags

Repository files navigation

Nest Logo

A progressive Node.js framework for building efficient and scalable server-side applications.

NPM Version NPM Downloads

Description

RESTful API for products & services market place with Nest framework.

Token

In order to use some of the endpoints you will need first to login and use your own token

In Request headers add prop calls "token"

example:

headers = {
  token: 'yourOwnToken',
};

And then send this as header, something like this

response = requests.get(url, { headers });

Important! .env file

in order to run the backend server successfully you have to provide some environment variables, see the .env.example file, copy it to a .env file, then update the variables in the .env file.

  • PORT: 3000, the port number you want the server to listen to.
  • DB_URI: "mongodb://localhost:27017/workers", the URL + name of the database to use.
  • JWT_SECRET: "just random string", important to enable the authentication.
  • JWT_EXPIRE: "3h", the time you want to give to access_token before it expires.

to have the mailing service working you need to specify this variables in your .env file see the provided .env.example file.

  • MAIL_HOST: SMTP server like "smtp.gmail.com" or "smtp.ethereal.email" for testing
  • MAIL_HOST_PORT: the port to the mail service in the smtp server, usually 587
  • MAIL_USER and MAIL_PASS: username to authenticate with the MAIL_HOST
  • MAIL_SENDER: "Workers <noreply@workers.com>" or whatever email the company will have

    read this to know how to set up these variables for testing you can generate a user and password automatically and use it for example, this one is generated when I wrote the documentation to see all the mail login with the user below here

    note: the ethereal smtp server is for testing, the messages are only here, for production use other smtp service

    MAIL_HOST="smtp.ethereal.email"
MAIL_HOST_PORT=587
MAIL_USER="keaton.mueller@ethereal.email"
MAIL_PASS="MZrC9udzDD4E8xJppA"
MAIL_SENDER="Workers <noreply@workers.com>"

API Endpoints

Authentication

POST /auth/register

request body props: (* means required)
  • name*: string, min length 2, max length 50
  • email*: valid email (---@---.---)
  • password*: strong password with at least 1 (number, lowercase, uppercase, symbol)
  • role*: accepts only "customer" or "vendor"
  • photo: string, url
  • job* for vendor: stirng min length 2, max 50
  • phone* for vendor: string, phone number
  • description* for vendor : string, min length 20, max length 500
  • address.gov* for vendor: string, the object Id of the governorate that is one of the existing ones in the database
  • address.city* for vendor: string, the object Id of the city
  • address.street: string, min length 3 max 100

Request body example:

{
  "name": "ali",
  "email": "ali@gmail.com",
  "password": "1234abCd!",
  "role": "vendor",
  "job": "graphic designer",
  "phone": "01234567891",
  "photo": "images.net/ali.png",
  "description": "Hello I am Ali"
  "address": {
    "gov": "65e4b9c77615d13c7864a0c4",
    "city": "65e4b9c77615d13c7864134g",
    "street": "Awl Abbas St."
  }
}

Response body if the user is regestered:

{
  "user": {
    "email": "the user email",
    "notApproved": true
  }
}

after adding the user successfully to the database, the server will send a confirmation code to the user's email the response body, user must go to the /auth/confirm route to complete the registration.

POST /auth/login

request an access_token

Request Body:

{
  "email": "ali@gmail.com",
  "password": "1234abCd!"
}

Resposne Body for status 200, and the user has confirmed their email

{
  "user": "{ object with user informations }"
  "access_token": "hfpashfuiwndlkfawlkejfoialwef.woiejfoijasoiejflwkejfajwoiefj.aoweijfoaiwjfioawjefoijasdlkfjawoiefj23oijodjfa09wjef3489rpjwefoijw"
}

Response Body for status 200, but the user has not confirmed their email

{
  "user": {
    "email": "the user email",
    "notApproved": true
  }
}

if the user is notApproved this means they have to confirm via email code, or resend the code, and confirm again.

POST /auth/confirm

to confirm a notApproved user body schema:

email: the email of the user code: number, the code sent to his email

{
  "email": "user@mail.com",
  "code": 12345
}

response is the same as login for approved users

{
  "user": {...},
  "access_token": "some strange long string",
}

GET /auth/code?email=user@mail.com&type=email

to get a confirmation code in case of forgot password, and email confirmation you have to specify the user email to send the code to, and the type of the code ("email", "password") if you want to resent a code then the type is "email" and if you forgot the password the type is "password"

response statuses

  • 200: email is sent
  • 404: user is not registered
  • 429: the rate of requests is very high

[!CAUTION] you must wait 30 seconds before calling this endpoint again

POST /auth/reset-password

to set a new password for the user to must call the /auth/code?type=password&email=aaa@bbb.ccc to get a code body schema:

email: the email of the user code: number, the code sent to his email code: the new password to be set

{
  "email": "user@mail.com",
  "code": 12345,
  "password": "Mu$t 8e $trong!"
}
Products

GET /products?page=1&limit=10&category=نجارة

query and it takes page and limit default is 1 and 20 respectively

category query is optional, if you want to filter by category (main or sub)

return:

{
  "data": [
    {
      "id": "65e5f83085020468684cf",
      "name": "test1",
      "price": 250,
      "description": "test test",
      "photos": [
        "https://i.imgur.com/1o3KcN6.png",
        "https://i.imgur.com/1o3KcN6.png",
        "https://i.imgur.com/1o3KcN6.png"
      ],
      "category": {
        "main": "نجاره",
        "sub": "خشب"
      },
      "vendor": {
        "id": "65e5f706e9c9ebb9d820",
        "name": "test",
        "gov": "65e36f850475bb457ced9",
        "city": "65e371f2617ef1dd3b697"
      },
      "totalOrders": 0,
      "avgRating": 0,
      "approved": false,
      "createdAt": "2024-03-04T16:34:56.971Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 10,
    "itemCount": 7,
    "pageCount": 1,
    "hasPreviousPage": false,
    "hasNextPage": false
  }
}

GET products/user/:userId

get all products by userId

return:

[
  {
    "_id": "65e5f83085020468684",
    "name": "test7",
    "price": 250,
    "description": "test test",
    "photos": [
      "https://i.imgur.com/1o3KcN6.png",
      "https://i.imgur.com/1o3KcN6.png",
      "https://i.imgur.com/1o3KcN6.png"
    ],
    "category": {
      "main": "نجاره",
      "sub": "خشب"
    },
    "vendor": {
      "id": "65e5f706e9c9ebb9d8205",
      "name": "test",
      "gov": "65e36f850475bb457ced9",
      "city": "65e371f2617ef1dd3b692"
    },
    "totalOrders": 0,
    "avgRating": 0,
    "approved": false,
    "createdAt": "2024-03-04T16:34:56.971Z",
    "__v": 0
  }
]

GET products/:productId

get product by Id

return:

{
  "id": "65e5f83085020468684cf",
  "name": "test1",
  "price": 250,
  "description": "test test",
  "photos": [
    "https://i.imgur.com/1o3KcN6.png",
    "https://i.imgur.com/1o3KcN6.png",
    "https://i.imgur.com/1o3KcN6.png"
  ],
  "category": {
    "main": "نجاره",
    "sub": "خشب"
  },
  "vendor": {
    "id": "65e5f706e9c9ebb9d820",
    "name": "test",
    "gov": "65e36f850475bb457ced9",
    "city": "65e371f2617ef1dd3b697"
  },
  "totalOrders": 0,
  "avgRating": 0,
  "approved": false,
  "createdAt": "2024-03-04T16:34:56.971Z"
}

POST /products

Create new product [!CAUTION] Requires Token

props: (* means required)
  • name*: string, min length 2, max length 50
  • price*: must be more than 0 and number
  • description*: type string
  • photos*: array of strings[] and min array length can be 0
  • description*: string, min length 20, max length 500
  • category.main*: must be string main category
  • category.sub*: must be string sub category

example:

{
  "name": "test4",
  "price": 250,
  "description": "test test",
  "photos": [
    "https://i.imgur.com/1o3KcN6.png",
    "https://i.imgur.com/1o3KcN6.png",
    "https://i.imgur.com/1o3KcN6.png"
  ],
  "category": {
    "main": "نجاره",
    "sub": "خشب"
  }
}

PATCH /products/:productId

Update product by productId [!CAUTION] Requires Token

props: (* means required)
  • name: string, min length 2, max length 50
  • price: must be more than 0 and number
  • description: type string
  • photos: array of strings[] and min array length can be 0
  • description: string, min length 20, max length 500
  • category.main: must be string main category
  • category.sub: must be string sub category
  • totalOrders: must be not less than 0
  • avgRating: must be not less than 0 and not more than 5
  • approved: is a boolen can be modified by admin

example:

{
  "name": "test4",
  "price": 250,
  "description": "test test",
  "photos": [
    "https://i.imgur.com/1o3KcN6.png",
    "https://i.imgur.com/1o3KcN6.png",
    "https://i.imgur.com/1o3KcN6.png"
  ],
  "category": {
    "main": "نجاره",
    "sub": "خشب"
  },
  "totalOrders": 0,
  "avgRating": 0,
  "approved": false
}

DELETE /products/:productId

Delete product by productId [!CAUTION] Requires Token

Services

GET /services?page=1&limit=10

query and it takes page and limit default is 1 and 20 respectively

return:

{
  "data": [
    {
      "id": "65e5f83085020468684cf",
      "name": "test1",
      "price": 250,
      "description": "test test",
      "photos": [
        "https://i.imgur.com/1o3KcN6.png",
        "https://i.imgur.com/1o3KcN6.png",
        "https://i.imgur.com/1o3KcN6.png"
      ],
      "category": {
        "main": "نجاره",
        "sub": "خشب"
      },
      "vendor": {
        "id": "65e5f706e9c9ebb9d820",
        "name": "test",
        "gov": "65e36f850475bb457ced9",
        "city": "65e371f2617ef1dd3b697"
      },
      "totalOrders": 0,
      "avgRating": 0,
      "approved": false,
      "createdAt": "2024-03-04T16:34:56.971Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 10,
    "itemCount": 7,
    "pageCount": 1,
    "hasPreviousPage": false,
    "hasNextPage": false
  }
}

GET services/user/:userId

get all services by userId

return:

[
  {
    "_id": "65e5f83085020468684",
    "name": "test7",
    "price": 250,
    "description": "test test",
    "photos": [
      "https://i.imgur.com/1o3KcN6.png",
      "https://i.imgur.com/1o3KcN6.png",
      "https://i.imgur.com/1o3KcN6.png"
    ],
    "category": {
      "main": "نجاره",
      "sub": "خشب"
    },
    "vendor": {
      "id": "65e5f706e9c9ebb9d8205",
      "name": "test",
      "gov": "65e36f850475bb457ced9",
      "city": "65e371f2617ef1dd3b692"
    },
    "totalOrders": 0,
    "avgRating": 0,
    "approved": false,
    "createdAt": "2024-03-04T16:34:56.971Z",
    "__v": 0
  }
]

GET services/:serviceId

get services by Id

return:

{
  "id": "65e5f83085020468684cf",
  "name": "test1",
  "price": 250,
  "description": "test test",
  "photos": [
    "https://i.imgur.com/1o3KcN6.png",
    "https://i.imgur.com/1o3KcN6.png",
    "https://i.imgur.com/1o3KcN6.png"
  ],
  "category": {
    "main": "نجاره",
    "sub": "خشب"
  },
  "vendor": {
    "id": "65e5f706e9c9ebb9d820",
    "name": "test",
    "gov": "65e36f850475bb457ced9",
    "city": "65e371f2617ef1dd3b697"
  },
  "totalOrders": 0,
  "avgRating": 0,
  "approved": false,
  "createdAt": "2024-03-04T16:34:56.971Z"
}

POST /services

Create new service [!CAUTION] Requires Token

props: (* means required)
  • name*: string, min length 2, max length 50
  • price*: must be more than 0 and number
  • description*: type string
  • photos*: array of strings[] and min array length is 1
  • description*: string, min length 20, max length 500
  • category.main*: must be string main category
  • category.sub*: must be string sub category

example:

{
  "name": "test4",
  "price": 250,
  "description": "test test",
  "photos": [
    "https://i.imgur.com/1o3KcN6.png",
    "https://i.imgur.com/1o3KcN6.png",
    "https://i.imgur.com/1o3KcN6.png"
  ],
  "category": {
    "main": "نجاره",
    "sub": "خشب"
  }
}

PATCH /services/:serviceId

Update service by servicesId [!CAUTION] Requires Token

props: (* means required)
  • name: string, min length 2, max length 50
  • price: must be more than 0 and number
  • description: type string
  • photos: array of strings[] and min array length is 1
  • description: string, min length 20, max length 500
  • category.main: must be string main category
  • category.sub: must be string sub category
  • totalOrders: must be not less than 0
  • avgRating: must be not less than 0 and not more than 5
  • approved: is a boolen can be modified by admin

example:

{
  "name": "test4",
  "price": 250,
  "description": "test test",
  "photos": [
    "https://i.imgur.com/1o3KcN6.png",
    "https://i.imgur.com/1o3KcN6.png",
    "https://i.imgur.com/1o3KcN6.png"
  ],
  "category": {
    "main": "نجاره",
    "sub": "خشب"
  },
  "totalOrders": 0,
  "avgRating": 0,
  "approved": false
}

DELETE /services/:serviceId

Delete service by serviceId [!CAUTION] Requires Token

Orders

GET /orders

get all orders for the current logged in user

GET /orders/:orderId

get infromations about specific order

DELETE /orders/:orderId

customer, vendor can delete products they have done.

POST /products/:productId/order

POST /services/:serviceId/order

submit an order request from the current logged in user user must be a customer (not even admin can do this)

[!CAUTION] Body Schema is object with message inside

{
  message: '500 > length > 10';
}
Users

GET /users?page=1&limit=10

query and it takes page and limit default is 1 and 20 respectively [!CAUTION] Requires Token

return:

{
  "data": [
    {
      "id": "65e5cd41f9206d7ec12597",
      "name": "ali",
      "email": "ali@gg.ez",
      "password": "hashedPassword",
      "role": "vendor",
      "address": {
        "gov": "65e36f850475bb457ced99a9",
        "city": "65e371f2617ef1dd3b697ec2"
      },
      "photo": "https/gg.ex",
      "description": "علي علوكا"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 10,
    "itemCount": 7,
    "pageCount": 1,
    "hasPreviousPage": false,
    "hasNextPage": false
  }
}

GET users/:userId

get user by Id [!CAUTION] Requires Token

return:

{
  "_id": "65e5cd41f9206d7ec12594",
  "name": "ali",
  "email": "ali@gg.ez",
  "role": "vendor",
  "address": {
    "gov": "65e36f850475bb457ced99a9",
    "city": "65e371f2617ef1dd3b697ec2"
  },
  "photo": "https/gg.ex",
  "description": "علي علوكا",
  "__v": 0
}

PATCH /users/:userId

Update user by userId [!CAUTION] Requires Token

props: (* means required)
  • name: string, min length 2, max length 50
  • password: strong password with at least 1 (number, lowercase, uppercase, symbol) -- ( if password found must provide newPassword )
  • newPasswword: strong password with at least 1 (number, lowercase, uppercase, symbol) -- ( if newPassword found must provide oldPassword as prop: "password" )
  • role: accepts only "customer" or "vendor"
  • photo: url
  • description: string, min length 20, max length 500
  • address.gov: string, the object Id of the governorate that is one of the existing ones in the database
  • address.city: string, the object Id of the city
  • address.street: string, min length 3 max 100

example:

{
  "name": "ali",
  "password": "oldPassword123@!",
  "newPassword": "newPassword123@!",
  "role": "vendor",
  "address": {
    "gov": "65e36f850475bb457ced99a9",
    "city": "65e371f2617ef1dd3b697ec2"
  },
  "photo": "https/gg.ex",
  "description": "علي علوكا",
  "__v": 0
}

DELETE /users/:userId

Delete user by serviceId [!CAUTION] Requires Token

Locations

GET /locatoins/governorates

get all available governorates

response

[
  {
    "_id": "65e36f850475bb457ced99a9",
    "name": "الاسكندرية",
    "__v": 0
  },
  {
    "_id": "65e36f850475bb457ced99ac",
    "name": "القاهرة",
    "__v": 0
  },
  {
    "_id": "65e36f850475bb457ced99ad",
    "name": "الشرقية",
    "__v": 0
  }
]

GET locations/cities/:govId

get cities in a governorate

response

[
  {
    "_id": "65e374093c963b2c090fe3b5",
    "name": "السلام",
    "gov": "65e36f850475bb457ced99ac",
    "__v": 0
  },
  {
    "_id": "65e374093c963b2c090fe3b6",
    "name": "المرج",
    "gov": "65e36f850475bb457ced99ac",
    "__v": 0
  },
  {
    "_id": "65e374093c963b2c090fe3b7",
    "name": "مدينة نصر",
    "gov": "65e36f850475bb457ced99ac",
    "__v": 0
  }
]

POST /locations/governorates

add new governorates

[!CAUTION] body schema: Array of strings

["الاقصر", "شمال سيناء", "البحيرة"]

POST /locations/cities/:govId

add new cities to a governorate

[!CAUTION] body schema: Array of strings

["السلام", "المرج", "مدينة نصر"]

DELETE /locations/governorates/:govId

delete a governorate and all related cities / users

DELETE /locations/cities/:cityId

delete a city and all related users

Categories

GET services/categories/

GET products/categories/

get all (services or products) categories

response body

[
  {
    "_id": "65e4b9c77615d13c7864a0c4",
    "name": "اعمال نجااااااارة",
    "description": "باب النجارين بتوعنا مش مخلع",
    "photo": "www/gg/ez",
    "__v": 0
  },
  {
    "_id": "65e86289ba817f471d0d653b",
    "name": "سبااااكههه",
    "description": "سباكين محنكين عالأخر",
    "photo": "www/gg/ez",
    "__v": 0
  }
]

GET services/categories/:categoryId

GET products/categories/:categoryId

get all (services or products) sub categories of one category

response body

[
  {
    "_id": "65e4c166934f4917574449b5",
    "name": "باب و شباك",
    "parent": "65e4b9c77615d13c7864a0c4",
    "__v": 0
  },
  {
    "_id": "65e4c166934f4917574449b7",
    "name": "مكاتب",
    "parent": "65e4b9c77615d13c7864a0c4",
    "__v": 0
  },
  {
    "_id": "65e77927c9bc33d8a77113cf",
    "name": "مطابخ",
    "parent": "65e4b9c77615d13c7864a0c4",
    "__v": 0
  }
]

POST services/categories/

POST products/categories/

add main category (services or products)

Body Schema: Object with the following props

  • name: required, string, min length 3, max length 50
  • photo: string, url
  • description: string min length 10 max lenght 500

request body

{
  "name": "سبااااكههه",
  "description": "سباكين محنكين عالأخر",
  "photo": "www/gg/ez"
}

response body if added successfully

{
  "name": "سبااااكههه",
  "description": "سباكين محنكين عالأخر",
  "photo": "www/gg/ez",
  "_id": "65e86289ba817f471d0d653b",
  "__v": 0
}

POST services/categories/:categoryId

POST products/categories/:categoryId

add sub categories to a category

[!CAUTION] body schema: Array of strings

request body

["باب و شباك", "مطابخ", "مكاتب"]

response body

... same as GET if no conflict happened

PATCH services/categories/:categoryId

PATCH products/categories/:categoryId

Update category by Id (main or sub)

Body Schema: Object with the following props

  • name: string, min length 3, max length 50
  • photo: string, url
  • description: string min length 10 max lenght 500

request body

{
  "name": "سباكه"
}

response body on success

{
  "name": "سباكه",
  "description": "سباكين محنكين عالأخر",
  "photo": "www/gg/ez",
  "_id": "65e86289ba817f471d0d653b",
  "__v": 0
}

DELETE services/categories/:categoryId

DELETE products/categories/:categoryId

Delete category (main or sub)

Search

GET /search?q="query"

query takes any string to search in products, services or vendor users

return:

{
  "products": [
    {
      "_id": "65ea40b19f38b1956072af85",
      "name": "testAp",
      "price": 250,
      "description": "test test",
      "photos": [
        "https://i.imgur.com/1o3KcN6.png",
        "https://i.imgur.com/1o3KcN6.png",
        "https://i.imgur.com/1o3KcN6.png"
      ],
      "category": {
        "main": "نجاره",
        "sub": "خشب"
      },
      "vendor": {
        "id": "65e5f706e9c9ebb9d820e575",
        "name": "test",
        "gov": "65e36f850475bb457ced99a9",
        "city": "65e371f2617ef1dd3b697ec2"
      },
      "totalOrders": 0,
      "avgRating": 0,
      "approved": false,
      "createdAt": "2024-03-07T22:33:21.468Z",
      "__v": 0
    }
  ],

  "services": [
    {
      "_id": "65ea42079ec515665816ccda",
      "name": "test",
      "price": 250,
      "description": "test test",
      "photos": [
        "https://i.imgur.com/1o3KcN6.png",
        "https://i.imgur.com/1o3KcN6.png",
        "https://i.imgur.com/1o3KcN6.png"
      ],
      "category": {
        "main": "نجاره",
        "sub": "خشب"
      },
      "vendor": {
        "id": "65e5f706e9c9ebb9d820e575",
        "name": "test",
        "gov": "65e36f850475bb457ced99a9",
        "city": "65e371f2617ef1dd3b697ec2"
      },
      "totalOrders": 0,
      "avgRating": 0,
      "approved": false,
      "createdAt": "2024-03-07T22:39:03.539Z",
      "__v": 0
    }
  ],

  "users": [
    {
      "_id": "65e62ca5b00ec58e08d2360d",
      "name": "test",
      "email": "test2@gmail.com",
      "role": "vendor",
      "address": {
        "gov": "65e36f850475bb457ced99a9",
        "city": "65e371f2617ef1dd3b697ec2"
      },
      "photo": "https/gg.ex",
      "description": "علي علوكا",
      "__v": 0,
      "createdAt": "2024-03-17T22:07:02.640Z"
    }
  ]
}

GET /search/exact?q="query"

query takes a word to search exactly for in products, services

return:

{
  "products": [
    {
      "_id": "65ea40b19f38b1956072af85",
      "name": "testAp",
      "price": 250,
      "description": "test test",
      "photos": [
        "https://i.imgur.com/1o3KcN6.png",
        "https://i.imgur.com/1o3KcN6.png",
        "https://i.imgur.com/1o3KcN6.png"
      ],
      "category": {
        "main": "نجاره",
        "sub": "خشب"
      },
      "vendor": {
        "id": "65e5f706e9c9ebb9d820e575",
        "name": "test",
        "gov": "65e36f850475bb457ced99a9",
        "city": "65e371f2617ef1dd3b697ec2"
      },
      "totalOrders": 0,
      "avgRating": 0,
      "approved": false,
      "createdAt": "2024-03-07T22:33:21.468Z",
      "__v": 0
    }
  ],

  "services": [
    {
      "_id": "65ea42079ec515665816ccda",
      "name": "test",
      "price": 250,
      "description": "test test",
      "photos": [
        "https://i.imgur.com/1o3KcN6.png",
        "https://i.imgur.com/1o3KcN6.png",
        "https://i.imgur.com/1o3KcN6.png"
      ],
      "category": {
        "main": "نجاره",
        "sub": "خشب"
      },
      "vendor": {
        "id": "65e5f706e9c9ebb9d820e575",
        "name": "test",
        "gov": "65e36f850475bb457ced99a9",
        "city": "65e371f2617ef1dd3b697ec2"
      },
      "totalOrders": 0,
      "avgRating": 0,
      "approved": false,
      "createdAt": "2024-03-07T22:39:03.539Z",
      "__v": 0
    }
  ]
}

GET /search/popular?limit=6

get the most ordered products and services

limit is optional but its default is 6

return:

{
  products: [...]
  services: [...]
}
Feedback

GET /services/:serviceId/feedback

get all feedback for this order

[!CAUTION] NOT Requires Token

return:

[
  {
    "_id": "65faecd39be1895d3b73b899",
    "customer": "65fac9bfd94342415c47c0d0",
    "vendor": "65e5f706e9c9ebb9d820e575",
    "service": "65ea42079ec515665816cce0",
    "comment": "good service with low cost",
    "rating": 5,
    "createdAt": "2024-03-20T14:04:03.201Z",
    "__v": 0
  },
  {
    "_id": "65faf7989be1895d3b73b8a0",
    "customer": "65fac9bfd94342415c47c0d0",
    "vendor": "65e5f706e9c9ebb9d820e575",
    "service": "65ea42079ec515665816cce0",
    "comment": "bad service with low cost",
    "rating": 2,
    "createdAt": "2024-03-20T14:50:00.122Z",
    "__v": 0
  }
]

GET /products/:productId/feedback

get all feedback for this product

DELETE /services/:serviceId/feedback

only customer or admin can delete feedback to service [!CAUTION] Requires Token

DELETE /products/:productId/feedback

only customer or admin can delete feedback to product [!CAUTION] Requires Token

POST /services/:serviceId/feedback

only customer can add feedback to service [!CAUTION] Requires Token

body:

{
  "comment": "bad service with low cost",
  "rating": 2
}

POST /products/:productId/feedback

only customer can add feedback to product [!CAUTION] Requires Token

[!CAUTION] Body Schema is object with comment (string)
rating( 0 <= number <= 5) inside

{
  comment: 'your message',
  rating: 0 to 5
}

Installation

$ npm install

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

License

Nest is MIT licensed.

About

RESTful API for products & services market place with Nest framework.

Topics

mognodb nestjs

Resources

Readme
Activity

Stars

1 star

Watchers

1 watching

Forks

2 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages