Skip to content

Latest commit

 

History

History
42 lines (34 loc) · 1.47 KB

REQUIREMENTS.md

File metadata and controls

42 lines (34 loc) · 1.47 KB
Raw

API Requirements

The company stakeholders want to create an online storefront to showcase their great product ideas. Users need to be able to browse an index of all products, see the specifics of a single product, and add products to an order that they can view in a cart page. You have been tasked with building the API that will support this application, and your coworker is building the frontend.

These are the notes from a meeting with the frontend developer that describe what endpoints the API needs to supply, as well as data shapes the frontend and backend have agreed meet the requirements of the application.

API Endpoints

Products

  • Index GET /products
  • Show GET /products/:id
  • Create [token required] POST /products

Users

  • Index [token required] GET /users
  • Show [token required] GET /users/:id
  • Create N[token required] POST /users

Orders

  • Current Order by user (args: user id)[token required] GET /orders/:id
  • [OPTIONAL] Completed Orders by user (args: user id)[token required] GET /completedorders/:id

Data Shapes

Note current_status in order table type is ENUM but I couldn't add it in the diagram

Product

  • id
  • name
  • price
  • [OPTIONAL] category

User

  • id
  • firstName
  • lastName
  • password

Orders

  • id
  • id of each product in the order
  • quantity of each product in the order
  • user_id
  • status of order (active or complete)