Skip to content

API Documentation

Jonathan Chan edited this page Apr 2, 2021 · 31 revisions

API-Routes

This web app uses the following API routes to dynamically update the page to create a single-page-app-like feel for the user for specific features.

Reviews

  • A logged in user may delete one of their own reviews, removing it from the list of visible reviews without causing a refresh/redirect. Creating:

    • POST /books/:id/reviews

    Edit: (the reviews or the stars)

    • PUT/PATCH /books/:id/reviews/:id

    Delete:

    • `DELETE /books/:id/reviews/:id
  • A logged in user

Books

Status

  • A logged in user can add a status to indicate whether they are "Read", "Currently Reading" or "Want to Read" (default).

    • POST/PUT/PATCH? /books/:id
  • A logged in user can add/remove a Book to their Bookshelf on the specific book's page via a custom category or through a Tag(Want to Read/Genre/etc).

    • 'POST /books/:id'
    • 'DELETE /books/:id'
    • 'PUT/PATCH /books/:id'

Clone this wiki locally