Skip to content

Momentum-Team-14/drf-library-api-Tomtuhtomtom

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

DRF Library API

Create a new API-only application that lets users keep track of books, including important information like title, author, publication date, a genre, and a field that marks it as "featured". Books should 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).

  1. users track books
  2. book has title, author, publication date, genre, featured
  3. constraint for book by title and author(title can be same if author is different)

Users should be able to search for a book by title or author.

  1. sort book by title or author

Anyone 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 whether it is "featured") and delete books.

  1. users can create a book if not already in library
  2. admin can update book details(featured) and delete books

You'll also need a book tracking model so that users can mark a book as "want to read", "reading", or "read/done"; this status can also be updated. The tracking model should have a foreign key to a book and to a user.

  1. tracking model has status and foreign keys to books and to users

Optionally users can take notes on books. These notes have a foreign key relationship with a book and a user, a datetime they are created, a note body, a boolean field marking it as public or private, and an optional page number. Private notes are viewable only by the author. When notes are retrieved, return them by creation time in reverse order.

  1. Users make notes on books - created time, public/private setting, page number optional
  2. Retreive by reverse date

Users should be able to see a list of all the books they are tracking, or a list by status (for instance, all their "want to read" books). You could consider using DjangoFilterBackend for this.

You should not make forms or templates for this app, but you will need models, urls, views, and serializers. You should use class-based views and return JSON responses.

Your app should allow users to:

  • list all books
  • list all featured books
  • create a book
  • retrieve details about a book
  • search books by author or title
  • see a list of all the books they are tracking and their statuses
  • mark a book as want to read, reading, or read
  • update the want to read/reading/read status of a book
  • see a list of all their books by status (e.g., all the books they have marked as "read")
  • retrieve all their own private notes for a book
  • retrieve all public notes for a book
  • create a note for a book
  • edit their own notes

Admin users can:

  • update a book (including marking/unmarking it as featured)
  • delete a book (this should not delete notes about a book)

You'll need to use Insomnia (or some other tool for making requests) to test your API as you are building it.

About

drf-library-api-Tomtuhtomtom created by GitHub Classroom

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published