DRF Library API

This application is an API built with Django REST Framework (DRF) that lets users track books that they want to read or are reading -- kind of like GoodReads. Books are listed with important information like title, author, publication date, and whether it is marked as “featured”.

Any logged-in user can add a new book as long as the same book is not already in the library. Only admin users can update book details (like marking it as featured) or delete books.

Books are be unique by title and author (that is, you can’t have two books with the same title and author; two books with the same title is fine as long as the authors are different).

Users can mark a book as “want to read”, “reading”, or “read/done”.

Users can also write reviews on books, which should be viewable to all users. Optionally, users can take private notes on books.

All requests, except registration and log in, require authentication.

Required Headers

Requests to endpoints requiring authentication should set the Authorization header to Token <token>, where <token> is the token received in the login response.

POST requests with a body should set the Content-Type header to application/json.

Register a new user

request

Username and password are required.

POST api/auth/users

{
  "username": "baby_yoda",
  "password": "grogu"
}

response

201 Created

{
  "email": "",
  "username": "baby_yoda",
  "id": 6
}

Log In

request

POST auth/login

{
  "username": "admin",
  "password": "admin"
}

response

{
  "auth_token": "c312049c7f034a3d1b52eabc2040b46e094ff34c"
}

List all books

Requires authentication.

request

GET api/books

response

[
  {
    "pk": 1,
    "title": "Paradise Lost",
    "author": "John Milton",
    "featured": true
  },
  {
    "pk": 2,
    "title": "The Countess of Pembroke's Arcadia",
    "author": "Philip Sidney",
    "featured": false
  },
  {
    "pk": 3,
    "title": "The Faerie Queene",
    "author": "Edmund Spenser",
    "featured": false
  }
]

List all featured books

Requires authentication.

request

GET api/books/featured

response

[
  {
    "pk": 1,
    "title": "Paradise Lost",
    "author": "John Milton",
    "publication_year": 1667,
    "featured": true,
    "reviews": [
      "http://127.0.0.1:8000/api/book_reviews/1"
    ]
  }
]

Details for a single book

Requires authentication.

request

GET api/books/{id}

response

[
  {
    "pk": 1,
    "title": "Paradise Lost",
    "author": "John Milton",
    "featured": true
  }
]

Create a new book

Requires authentication.

request

title and author are required fields.

POST api/books

{
   "title": "The Anatomy of Melancholy",
   "author": "Robert Burton",
   "publication_year": 1621
}

response

201 Created

{
  "pk": 6,
  "title": "The Anatomy of Melancholy",
  "author": "Robert Burton",
  "publication_year": 1621,
  "featured": false,
  "reviews": []
}

Update a book

Requires authentication. Available only to admin users.

request

PATCH api/books/{id}

{
  "featured": true
}

response

200 OK

{
  "pk": 6,
  "title": "The Anatomy of Melancholy",
  "author": "Robert Burton",
  "publication_year": 1621,
  "featured": true,
  "reviews": []
}

Get all reviews for a single book

Requires authentication.

request

GET api/books/{id}/reviews

response

[
  {
    "pk": 1,
    "body": "Satan is a compelling hero.",
    "book": "Paradise Lost",
    "reviewed_by": "amy"
  },
  {
    ...
  },
]

Create a review for a single book

Requires authentication.

request

POST api/books/{id}/reviews

 {
  "body": "This is the best book ever."
 }

response

201 Created

{
  "pk": 3,
  "body": "This is the best book ever.",
  "book": "The Countess of Pembroke's Arcadia",
  "reviewed_by": "belletrix"
}

Search books by title and review

Searches title field of books and body of reviews. Returns matching book objects.

Include query parameter search with the keyword(s) that you want to search for. Requires authentication.

request

GET api/books?search=hope

response

[
  {
    "pk": 4,
    "title": "Sense and Sensibility",
    "author": "Jane Austen",
    "featured": true
  },
  {
    "pk": 1,
    "title": "Paradise Lost",
    "author": "John Milton",
    "featured": true
  }
]

Search book reviews

Searches the body of book reviews and returns matching book review objects.

Include query parameter search with the keyword(s) that you want to search for. Requires authentication.

request

GET api/books/1/reviews?search=hope

response

200 OK

[
  {
    "pk": 12,
    "body": "Underground chapel drive blue devils bouncing bulldogs, seventy duke forest. Corcoran urban farmer big green wall coworking artwalk coffee history hub, foodie main street full frame watts beer, rtp brewery marry durham cupcakes angier drive. Biker bar lemur center durham divas rigsbee university sodu oprah building, artwalk five points seeds vintage subaru five points rigsbee, bull durham sodu subaru hope valley bowtie.",
    "book": "Paradise Lost",
    "reviewed_by": "a_user"
  }
]