API Endpoints - dvidale/python-react-group-proj GitHub Wiki

Auth Routes

Current User

  • Purpose: This fetch ensures the current user is authorized to access the data from the current area of the application.

  • Method: GET

  • URL: /auth

  • Successful Response: HTTP Status 200

    {
        'id': INT,
        'first_name': STRING,
        'last_name': STRING,
        'username': STRING,
        'email': STRING,
        'city': STRING,
        'state': STRING
    }
  • Error Response: HTTP Status 401
    {
        'errors': {'message': 'Unauthorized'}
    }

Login

  • Purpose: This request attempts to login a user with the provided credentials

  • Method: POST

  • URL: /login

  • Request Body:

{
    'email': STRING,
    'password':STRING
}
  • Successful Response: HTTP Status 200
    {
        'id': INT,
        'first_name': STRING,
        'last_name': STRING,
        'username': STRING,
        'email': STRING,
        'city': STRING,
        'state': STRING
    }
  • Error Response: HTTP Status 401
    {
        'errors': [ARRAY OF STRINGS]
    }

Logout

  • Purpose: This fetch replaces the current user session information with null, terminating their access to the application.

  • Method: GET

  • URL: /logout

  • Successful Response: HTTP Status 200

    {
        'message': 'User logged out'
    }

Sign Up

  • Purpose: This request attempts to create a new user with the provided user input

  • Method: POST

  • URL: /signup

  • Request Body:

{
        'first_name': STRING,
        'last_name': STRING,
        'username': STRING,
        'email': STRING,
        'password': STRING,
        'address': STRING,
        'city': STRING,
        'state': STRING,
        'zip': INT,
        'phone_number':INT
}
  • Successful Response: HTTP Status 200
    {
        'id': INT,
        'first_name': STRING,
        'last_name': STRING,
        'username': STRING,
        'email': STRING,
        'city': STRING,
        'state': STRING
    }
  • Error Response: HTTP Status 401
    {
        'errors': [ARRAY OF STRINGS]
    }

RESTAURANTS

GET ALL CATEGORIES

  • Purpose : This fetch populates the front page categories currently represented by the listed restaurants.

  • Method: GET

  • URL: /restaurants/categories

  • Successful Response: HTTP Status 200

    {
    'id': INT,
    'categ_name':STRING,
    'img_url':STRING
}

  • Error Response: HTTP Status 404

        {
        'error': 'No restaurant categories found'.
    }

GET ALL RESTAURANTS

  • Purpose : This fetch populates the home page with all the restaurants currently offering delivery.

  • Method: GET

  • URL: /restaurants

  • Successful Response: HTTP Status 200

    {
        'id':INT,
        'owner_id':INT,
        'name':STRING,
        'address':STRING,
        'phone_number':STRING,
        'description':STRING,
        'banner_img':STRING,
        'day_of_week':STRING,
        'open_time':STRING,
        'close_time':STRING,
        'delivery_time':STRING,
        'delivery_fee': FLOAT,
        'categories': [...],
        'average_rating': FLOAT
    }
  • Error Response: HTTP Status 404 
        {
        'error': 'No restaurants were found.'
    }

GET RESTAURANT DETAILS

  • Purpose : This fetch gathers detailed information for a specific restaurant.
  • Method: GET
  • URL: /restaurants/:id

  • Successful Response: HTTP Status 200

    {
        'id':INT,
        'owner_id':INT,
        'name':STRING,
        'address':STRING,
        'phone_number':STRING,
        'description':STRING,
        'banner_img':STRING,
        'day_of_week':STRING,
        'open_time':STRING,
        'close_time':STRING,
        'delivery_time':STRING,
        'delivery_fee': FLOAT,
        'categories': [...],
        'average_rating': FLOAT
    }

  • Error Response: HTTP Status 404

        {
        'error': 'Restaurant not found.'
    }

CREATE A NEW RESTAURANT

  • Purpose : This request creates a new restaurant listing owned by the current logged in user.

  • Method: POST

  • URL: /restaurants/new

  • Request Body

    {
        'owner_id': INT,
        'name': STRING,
        'address': STRING,
        'phone_number': STRING,
        'description': STRING,
        'categories': [],
        'open_time': STRING,
        'close_time': STRING,
        'delivery_time': STRING,
        'delivery_fee': STRING,
        'banner_img': STRING
    }
  • Successful Response: HTTP Status 201 
    {
        'id':INT,
        'owner_id':INT,
        'name':STRING,
        'address':STRING,
        'phone_number':STRING,
        'description':STRING,
        'banner_img':STRING,
        'day_of_week':STRING,
        'open_time':STRING,
        'close_time':STRING,
        'delivery_time':STRING,
        'delivery_fee': FLOAT,
        'categories': [...],
        'average_rating': FLOAT
    }
  • Successful Response: HTTP Status 201
    {
        'id':INT,
        'owner_id':INT,
        'name':STRING,
        'address':STRING,
        'phone_number':STRING,
        'description':STRING,
        'banner_img':STRING,
        'day_of_week':STRING,
        'open_time':STRING,
        'close_time':STRING,
        'delivery_time':STRING,
        'delivery_fee': FLOAT,
        'categories': [...],
        'average_rating': FLOAT
    }
  • Error Response: HTTP Status 400
   {
       'name': ['Name is required.', 'This field requires 2 - 50 characters'],
       'address': ['Address is required.', 'This field requires 2 - 50 characters'],
       'phone_number': ['Phone number is required.', 'This field requires 10 characters'],
       'description': ['Description is required.', 'This field requires 20 - 70 characters'],
       'open_time': ['This field requires 5 characters'],
       'close_time': ['This field requires 5 characters'],
       'delivery_time': ['Delivery time is required.'],
       'delivery_fee': ['Delivery fee is required.'],
       'banner_img': ['Banner image is required.'],
       'categories': ['Category is required.']
   }

UPDATE A RESTAURANT

Purpose : This request updates an existing restaurant listing owned by the current logged in user.

  • Method: PUT

  • URL: /restaurants/:id

  • Request Body

    {
        'owner_id': INT,
        'name': STRING,
        'address': STRING,
        'phone_number': STRING,
        'description': STRING,
        'categories': [],
        'open_time': STRING,
        'close_time': STRING,
        'delivery_time': STRING,
        'delivery_fee': STRING,
        'banner_img': STRING
    }
  • Successful Response: HTTP Status 200
   {
           'id':INT,
           'owner_id':INT,
           'name':STRING,
           'address':STRING,
           'phone_number':STRING,
           'description':STRING,
           'banner_img':STRING,
           'day_of_week':STRING,
           'open_time':STRING,
           'close_time':STRING,
           'delivery_time':STRING,
           'delivery_fee': FLOAT,
           'categories': [...],
           'average_rating': FLOAT
       }
  • Error Response: HTTP Status 400
    {
        'name': ['Name is required.', 'This field requires 2 - 50 characters'],
        'address': ['Address is required.', 'This field requires 2 - 50 characters'],
        'phone_number': ['Phone number is required.', 'This field requires 10 characters'],
        'description': ['Description is required.', 'This field requires 20 - 70 characters'],
        'open_time': ['This field requires 5 characters'],
        'close_time': ['This field requires 5 characters'],
        'delivery_time': ['Delivery time is required.'],
        'delivery_fee': ['Delivery fee is required.'],
        'banner_img': ['Banner image is required.'],
        'categories': ['Category is required.']
    }

DELETE A RESTAURANT

  • Purpose : This request allows the current logged in user to delete a restaurant listing they created.
  • Method: DELETE
  • URL: /restaurants/:id
  • Successful Response: HTTP Status 200
{
    "message" : "Delete Successful"
}
  • Error Response: HTTP Status 500
    {
        'error': 'Error deleting restaurant'
    }

REVIEWS

GET ALL REVIEWS

  • Purpose: This fetch request populates all reviews across all restaurants.

  • Method: GET

  • URL: /reviews

  • Successful Response: HTTP Status 200

        {
        'id':INT,
        'user_id':INT,
        'user_first_name':STRING,
        'user_last_name':STRING,
        'restaurant_id':INT,
        'rating':FLOAT,
        'comments': STRING,
        'created_at': DATETIME
    }

  • Error Response: HTTP Status 404

        {
        'Error': 'There are no reviews.'
    }

GET A SPECIFIC REVIEW

  • Purpose: This fetch request populates one specific review.

  • Method: GET

  • URL: /reviews/:id

  • Successful Response: HTTP Status 200

        {
        'id':INT,
        'user_id':INT,
        'user_first_name':STRING,
        'user_last_name':STRING,
        'restaurant_id':INT,
        'rating':FLOAT,
        'comments': STRING,
        'created_at': DATETIME
    }

  • Error Response: HTTP Status 404

        {
        'Error': 'This review does not exist.'
    }

GET MOST RECENT REVIEW

  • Purpose: This fetch request populates the most recent review made on a particular restaurant.

  • Method: GET

  • URL: /restaurants/:id/recent

  • Successful Response: HTTP Status 200

        {
        'id':INT,
        'user_id':INT,
        'user_first_name':STRING,
        'user_last_name':STRING,
        'restaurant_id':INT,
        'rating':FLOAT,
        'comments': STRING,
        'created_at': DATETIME
    }

  • Error Response: HTTP Status 404

        {
        'Error': 'There are no reviews for this restaurant.'
    }

GET REVIEW SUMMARY: TOTAL REVIEWS AND AVERAGE RATING

  • Purpose: This fetch request populates the total reviews and average rating for a particular restaurant.

  • Method: GET

  • URL: /restaurants/:id/totalreviews

  • Successful Response: HTTP Status 200

        {
        'total_reviews':INT,
        'average_rating':FLOAT
    }

  • Error Response: HTTP Status 404

        {
        'Error': 'Restaurant could not be found.'
    }

CREATE A REVIEW

  • Purpose: This fetch request allows a user to create a review.

  • Method: POST

  • URL: /restaurants/:id/reviews

  • Successful Response: HTTP Status 201

        {
        'id':INT,
        'user_id':INT,
        'user_first_name':STRING,
        'user_last_name':STRING,
        'restaurant_id':INT,
        'rating':FLOAT,
        'comments': STRING,
        'created_at': DATETIME
    }

  • Error Response: HTTP Status 404

        {
        'Error': 'There was an error processing your review.'
    }

EDIT A REVIEW

  • Purpose: This fetch request allows a user to edit a previously created review.

  • Method: PUT

  • URL: /reviews/:id/

  • Successful Response: HTTP Status 200

        {
        'id':INT,
        'user_id':INT,
        'user_first_name':STRING,
        'user_last_name':STRING,
        'restaurant_id':INT,
        'rating':FLOAT,
        'comments': STRING,
        'created_at': DATETIME
    }

  • Error Response: HTTP Status 404

        {
        'Error': 'Review could not be found.'
    }

DELETE A REVIEW

  • Purpose: This fetch request allows a user to delete a previously created review.

  • Method: DELETE

  • URL: /reviews/:id/

  • Successful Response: HTTP Status 200

        {
        'message': 'Review was successfully deleted.'
    }

  • Error Response: HTTP Status 404

        {
        'Error': 'Review could not be found.'
    }

Shopping Cart

GET ALL CART ITEMS

  • Purpose: Fetch the current user's shopping cart with all items.

  • Method: GET

  • URL: /shopping-cart/current

  • Successful Response: HTTP Status 200

        {
    "cart_items": [
        {
            "id": INT,
            "menu_item_id": INT,
            "item_quantity": INT,
            "menu_item": {
                "name": STRING,
                "description": STRING,
                "price": DECIMAL,
                "image_url": STRING,
                'restaurant_id': INT,
            }
        }
    ]
}

  • Error Response: HTTP Status 404

        {
    "error": "Shopping cart not found"
    }

ADD ITEM TO CART

  • Purpose: Add a new item to the current user's cart.
  • Method: POST
  • URL: /shopping-cart/current/new
  • Successful Response: HTTP Status 201 
        {
        "id": INT,
        "menu_item_id": INT,
        "item_quantity": 1,
        "menu_item": {
            "name": STRING,
            "description": STRING,
            "price": DECIMAL,
            "image_url": STRING,
            'restaurant_id': INT,
        }
    }
  • Error Response 404 
        {
         "error": "Menu item not found"
    }
  • Error Response 400 
        {
         "error": "Item already in cart"
    }

UPDATE CART ITEM QUANTITY

  • Purpose: Update the quantity of an item in the cart (increment or decrement).
  • Method: POST
  • URL: /shopping-cart/current/<int:id>/update
  • Successful Response: HTTP Status 200 
        {
        "id": INT,
        "menu_item_id": INT,
        "item_quantity": INT,
        "menu_item": {
            "name": STRING,
            "description": STRING,
            "price": DECIMAL,
            "image_url": STRING,
            'restaurant_id': INT,
        }
    }
  • Error Response: 404 
      {
       "error":  "Cart item not found"
  }

DELETE ITEM FROM CART

  • Purpose: Remove an item from the current user's cart.

  • Method: DELETE

  • URL: /shopping-cart/current/<int:cart_item_id>/remove

  • Successful Response: HTTP Status 200

    {
    "message": "Cart item removed successfully"
}

  • Error Response: 404

      {
       "error":  "Cart item not found"
  }

Menu Items

GET ALL MENU ITEMS FOR A RESTAURANT

  • Purpose: Fetch all menu items for a specific restaurant.
  • Method: GET
  • URL: /restaurants/<int:id>/menu-items
  • Successful Response: HTTP Status 200 
        [
        {
            "id": INT,
            "restaurant_id": INT,
            "name": STRING,
            "description": STRING,
            "price": DECIMAL,
            "image_url": STRING,
            "quantity": INT,
            "like_percentage": FLOAT
        }
    ]
  • Error Response 404 
        {
        "error":  "Restaurant not found"
    }

ADD NEW MENU ITEM

  • Purpose: Add a new menu item to a restaurant.

  • Method: POST

  • URL: /restaurants/<int:id>/menu-items/new

  • Request Body:

      {
    "name": STRING,
    "price": DECIMAL,
    "description": STRING,
    "quantity": INT,
    "image_url": STRING
  }

  • Successful Response: HTTP Status 200

    {
    "id": INT,
    "restaurant_id": INT,
    "name": STRING,
    "description": STRING,
    "price": DECIMAL,
    "image_url": STRING,
    "quantity": INT,
    "like_percentage": FLOAT
}

  • Error Response 404

        {
        "error": "Restaurant not found"
    }

  • Error Response 400: Form validation errors.

      {
    "errors": {
        "name": ["This field is required"],
        "price": ["Must be a positive number"]
    }
}

UPDATE MENU ITEM

  • Purpose: Update a menu item's details.

  • Method: PUT or PATCH

  • URL: /menu-items/<int:id>

  • Request Body:

    {
   "name": STRING,
   "price": DECIMAL,
   "description": STRING,
   "image_url": STRING
}

  • Successful Response: HTTP Status 200

    {
    "id": INT,
    "name": STRING,
    "description": STRING,
    "price": DECIMAL,
    "image_url": STRING
}

  • Error Response 404

        {
        "message": "Menu item not found"
    }

DELETE MENU ITEM

  • Purpose: Remove a menu item from the restaurant's listing.
  • Method: DELETE
  • URL: /menu-items/<int:id>
  • Successful Response: HTTP Status 200 
        {
    "message": "Successfully Deleted Item"
    }
  • Error Response 404 
        {
        "message": "Menu item not found"
    }
⚠️ **GitHub.com Fallback** ⚠️