Skip to content

API documentation

Jump to bottom
c-rose-g edited this page Nov 22, 2022 · 4 revisions

USER AUTHENTICATION/AUTHORIZATION

All endpoints that require authentication

All endpoints that require a current user to be logged in.

  • Request: endpoints that require authentication
  • Error Response: Require authentication

    • Status Code: 401

    • Headers:

      • Content-Type: application/json

    • Body:

      {
  "message": "Authentication required",
  "statusCode": 401
}

All endpoints that require proper authorization

All endpoints that require authentication and the current user does not have the correct role(s) or permission(s).

  • Request: endpoints that require proper authorization
  • Error Response: Require proper authorization

    • Status Code: 403

    • Headers:

      • Content-Type: application/json

    • Body:

      {
  "message": "Forbidden",
  "statusCode": 403
}

Get the Current User

Returns the information about the current user that is logged in.

  • Require Authentication: true

  • Request

    • Method: GET
    • URL: api/login
    • Body: none

  • Successful Response

    • Status Code: 200

    • Headers:

      • Content-Type: application/json

    • Body:

      {
  "id": 1,
  "firstName": "John",
  "lastName": "Smith",
  "email": "john.smith@gmail.com",
  "username": "JohnSmith"
}

Log In a User

Logs in a current user with valid credentials and returns the current user's information.

  • Require Authentication: false

  • Request

    • Method: GET

    • URL: api/login

    • Headers:

      • Content-Type: application/json

    • Body:

      {
  "credential": "john.smith@gmail.com",
  "password": "secret password"
}

  • Successful Response

    • Status Code: 200

    • Headers:

      • Content-Type: application/json

    • Body:

      {
  "id": 1,
  "firstName": "John",
  "lastName": "Smith",
  "email": "john.smith@gmail.com",
  "username": "JohnSmith",
  "token": ""
}

  • Error Response: Invalid credentials

    • Status Code: 401

    • Headers:

      • Content-Type: application/json

    • Body:

      {
  "message": "Invalid credentials",
  "statusCode": 401
}

  • Error response: Body validation errors

    • Status Code: 400

    • Headers:

      • Content-Type: application/json

    • Body:

      {
  "message": "Validation error",
  "statusCode": 400,
  "errors": {
    "credential": "Email or username is required",
    "password": "Password is required"
  }
}

Sign Up a User

Creates a new user, logs them in as the current user, and returns the current user's information.

  • Require Authentication: false

  • Request

    • Method: POST

    • URL: api/users

    • Headers:

      • Content-Type: application/json

    • Body:

      {
  "firstName": "John",
  "lastName": "Smith",
  "email": "john.smith@gmail.com",
  "username": "JohnSmith",
  "password": "secret password"
}

  • Successful Response

    • Status Code: 200

    • Headers:

      • Content-Type: application/json

    • Body:

      {
  "id": 1,
  "firstName": "John",
  "lastName": "Smith",
  "email": "john.smith@gmail.com",
  "username": "JohnSmith",
  "token": ""
}

  • Error response: User already exists with the specified email

    • Status Code: 403

    • Headers:

      • Content-Type: application/json

    • Body:

      {
  "message": "User already exists",
  "statusCode": 403,
  "errors": {
    "email": "User with that email already exists"
  }
}

  • Error response: User already exists with the specified username

    • Status Code: 403

    • Headers:

      • Content-Type: application/json

    • Body:

      {
  "message": "User already exists",
  "statusCode": 403,
  "errors": {
    "username": "User with that username already exists"
  }
}

  • Error response: Body validation errors

    • Status Code: 400

    • Headers:

      • Content-Type: application/json

    • Body:

      {
  "message": "Validation error",
  "statusCode": 400,
  "errors": {
    "email": "Invalid email",
    "username": "Username is required",
    "firstName": "First Name is required",
    "lastName": "Last Name is required"
  }
}

ITEMS

Get all Items

Returns all the items.

  • Require Authentication: false

  • Request

    • Method: GET
    • URL: api/items
    • Body: none

  • Successful Response

    • Status Code: 200

    • Headers:

      • Content-Type: application/json

    • Body:

      {
  "Items": [
    {
      "id": 1,
      "product_name": "mascara",
      "item_price": 12,
      "createdAt": "2022-11-21 20:39:36",
      "updatedAt": "2022-11-21 20:39:36",
      "review": "I loved this product!",
      "product_photo": "image url"
      "department_name": "Makeup"
    }
  ]
}

Get details of an Item from an id

Returns the details of a spot specified by its id.

  • Require Authentication: false

  • Request

    • Method: GET
    • URL: api/items/:itemId
    • Body: none

  • Successful Response

    • Status Code: 200

    • Headers:

      • Content-Type: application/json

    • Body:

      {
  "id": 1,
  "name": "App Academy",
  "item_description": "Concealer for dark circles.",
  "price": 123,
  "createdAt": "2021-11-19 20:39:36",
  "updatedAt": "2021-11-19 20:39:36" ,
  "reviews": "this is a great produce"
  "ItemsPhotos": [
    {
      "id": 1,
      "url": "image url",
      "preview": true
    },
    {
      "id": 2,
      "url": "image url",
      "preview": false
    }
  ],
}

  • Error response: Couldn't find an Item with the specified id

    • Status Code: 404

    • Headers:

      • Content-Type: application/json

    • Body:

      {
  "message": "Item couldn't be found",
  "statusCode": 404
}

Get all Reviews of the Current User

Returns all the reviews written by the current user.

  • Require Authentication: true

  • Request

    • Method: GET
    • URL: api/reviews/currentUser
    • Body: none

  • Successful Response

    • Status Code: 200

    • Headers:

      • Content-Type: application/json

    • Body:

      {
  "Reviews": [
    {
      "id": 1,
      "userId": 1,
      "itemId": 1,
      "review": "This was an awesome product!",
      "stars": 5,
      "createdAt": "2021-11-19 20:39:36",
      "updatedAt": "2021-11-19 20:39:36" ,
      "User": {
        "id": 1,
        "firstName": "John",
        "lastName": "Smith"
      },
      "Item": {
        "id": 1,
        "itemName": "Mascara",
        "price": 123,
        "itemPhoto": "image url"
      },
      "ReviewImages": [
        {
          "id": 1,
          "url": "image url"
        }
      ]
    }
  ]
}

Get all Reviews by an Item's id

Returns all the reviews that belong to an item specified by id.

  • Require Authentication: false

  • Request

    • Method: GET
    • URL: api/items/:itemId/reviews
    • Body: none

  • Successful Response

    • Status Code: 200

    • Headers:

      • Content-Type: application/json

    • Body:

      {
  "Reviews": [
    {
      "id": 1,
      "userId": 1,
      "itemId": 1,
      "review": "This was an awesome product!",
      "stars": 5,
      "createdAt": "2021-11-19 20:39:36",
      "updatedAt": "2021-11-19 20:39:36" ,
      "User": {
        "id": 1,
        "firstName": "John",
        "lastName": "Smith"
      },
      "ReviewPhotos": [
        {
          "id": 1,
          "url": "image url"
        }
      ],
    }
  ]
}

  • Error response: Couldn't find an Item with the specified id

    • Status Code: 404

    • Headers:

      • Content-Type: application/json

    • Body:

      {
  "message": "Item couldn't be found",
  "statusCode": 404
}

Create a Review for an Item based on the Item's id

Create and return a new review for an Item specified by id.

  • Require Authentication: true

  • Request

    • Method: POST

    • URL: api/items/:itemId/reviews

    • Headers:

      • Content-Type: application/json

    • Body:

      {
  "review": "This was an awesome product!",
  "stars": 5,
}

  • Successful Response

    • Status Code: 201

    • Headers:

      • Content-Type: application/json

    • Body:

      {
  "id": 1,
  "userId": 1,
  "itemId": 1,
  "review": "This was an awesome product!",
  "stars": 5,
  "createdAt": "2021-11-19 20:39:36",
  "updatedAt": "2021-11-19 20:39:36"
}

  • Error Response: Body validation errors

    • Status Code: 400

    • Headers:

      • Content-Type: application/json

    • Body:

      {
  "message": "Validation error",
  "statusCode": 400,
  "errors": {
    "review": "Review text is required",
    "stars": "Stars must be an integer from 1 to 5",
  }
}

  • Error response: Couldn't find an Item with the specified id

    • Status Code: 404

    • Headers:

      • Content-Type: application/json

    • Body:

      {
  "message": "Item couldn't be found",
  "statusCode": 404
}

  • Error response: Review from the current user already exists for an Item

    • Status Code: 403

    • Headers:

      • Content-Type: application/json

    • Body:

      {
  "message": "User already has a review for this Item",
  "statusCode": 403
}

Add an Image to a Review based on the Review's id

Create and return a new image for a review specified by id.

  • Require Authentication: true

  • Require proper authorization: Review must belong to the current user

  • Request

    • Method: POST

    • URL: api/reviews/:reviewId/review-photos

    • Headers:

      • Content-Type: application/json

    • Body:

      {
  "url": "image url"
}

  • Successful Response

    • Status Code: 200

    • Headers:

      • Content-Type: application/json

    • Body:

      {
  "id": 1,
  "url": "image url"
}

  • Error response: Couldn't find a Review with the specified id

    • Status Code: 404

    • Headers:

      • Content-Type: application/json

    • Body:

      {
  "message": "Review couldn't be found",
  "statusCode": 404
}

Edit a Review

Update and return an existing review.

  • Require Authentication: true

  • Require proper authorization: Review must belong to the current user

  • Request

    • Method: PUT

    • URL: api/reviews/:reviewId

    • Headers:

      • Content-Type: application/json

    • Body:

      {
  "review": "This was an awesome spot!",
  "stars": 5,
}

  • Successful Response

    • Status Code: 200

    • Headers:

      • Content-Type: application/json

    • Body:

      {
  "id": 1,
  "userId": 1,
  "itemId": 1,
  "review": "This was an awesome product!",
  "stars": 5,
  "createdAt": "2021-11-19 20:39:36",
  "updatedAt": "2021-11-20 10:06:40"
}

  • Error Response: Body validation errors

    • Status Code: 400

    • Headers:

      • Content-Type: application/json

    • Body:

      {
  "message": "Validation error",
  "statusCode": 400,
  "errors": {
    "review": "Review text is required",
    "stars": "Stars must be an integer from 1 to 5",
  }
}

  • Error response: Couldn't find a Review with the specified id

    • Status Code: 404

    • Headers:

      • Content-Type: application/json

    • Body:

      {
  "message": "Review couldn't be found",
  "statusCode": 404
}

Delete a Review

Delete an existing review.

  • Require Authentication: true

  • Require proper authorization: Review must belong to the current user

  • Request

    • Method: DELETE
    • URL: api/reviews/:reviewId
    • Body: none

  • Successful Response

    • Status Code: 200

    • Headers:

      • Content-Type: application/json

    • Body:

      {
  "message": "Successfully deleted",
  "statusCode": 200
}

  • Error response: Couldn't find a Review with the specified id

    • Status Code: 404

    • Headers:

      • Content-Type: application/json

    • Body:

      {
  "message": "Review couldn't be found",
  "statusCode": 404
}

SHOPPING HISTORY

Get the Shopping History of the Current User.

Return all the bookings that the current user has made.

  • Require Authentication: true

  • Request

    • Method: GET
    • URL: api/shoppingHistory/user
    • Body: none

  • Successful Response

    • Status Code: 200

    • Headers:

      • Content-Type: application/json

    • Body:

      {
  "ShoppingHistory": [
    {
      "id": 1,
      "itemId": 1,
      "Item": {
        "id": 1,
        "name": "Mascara",
        "price": 123,
        "previewPhoto": "image url"
      },
      "userId": 2,
      "purchaseDate": "2021-11-19",
      "createdAt": "2021-11-19 20:39:36",
      "updatedAt": "2021-11-19 20:39:36"
    }
  ]
}

IMAGES

Delete a Review Image

Delete an existing image for a Review.

  • Require Authentication: true

  • Require proper authorization: Review must belong to the current user

  • Request

    • Method: DELETE
    • URL: api/review-images/:reviewImageId
    • Body: none

  • Successful Response

    • Status Code: 200

    • Headers:

      • Content-Type: application/json

    • Body:

      {
  "message": "Successfully deleted",
  "statusCode": 200
}

  • Error response: Couldn't find a Review Image with the specified id

    • Status Code: 404

    • Headers:

      • Content-Type: application/json

    • Body:

      {
  "message": "Review Image couldn't be found",
  "statusCode": 404
}

Clone this wiki locally