Django Book Management API

A Django REST API for managing books, users, and reading lists with full CRUD operations and user authentication.

Features

• User Management: Registration, login, profile management
• Book Management: Create, read, update, delete books with metadata
• Reading Lists: Personal reading lists with custom ordering
• Authentication: Token-based authentication and authorization
• Error Handling: Comprehensive error responses with validation

Requirements

• Python 3.8+
• Django 4.2+
• Django REST Framework 3.14+
• PostgreSQL (recommended) or SQLite for development

Installation & Setup

1. Clone the Repository

git clone https://github.com/Jasir-p/book-management.git
cd bookmangement

2. Create Virtual Environment

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

3. Install Dependencies

pip install -r requirements.txt

4. Environment Configuration

Create a .env file in the project root:

DEBUG=True
SECRET_KEY=your-secret-key-here
ALLOWED_HOSTS="*"
CORS_ALLOWED_ORIGINS="http://localhost:8000"
DB_ENGINE="your-db-engine-postgres-recommended"
DB_NAME="your-db-name"
DB_USER="your-db-user"
DB_PASSWORD="your-db-password"
DB_HOST="your-db-host-or-default-localhost"
DB_PORT="your-db-port-or-default-5432"

5. Database Setup

python manage.py makemigrations
python manage.py migrate
python manage.py createsuperuser  # Optional: for admin access

6. Run the Server

python manage.py runserver

The API will be available at http://localhost:8000/

API Documentation

Base URL

http://localhost:8000/api/

Authentication

The API uses Token-based authentication. Include the token in the Authorization header:

Authorization: Token <your-token-here>

Request/Response Examples

User Registration

POST /api/users/register
Content-Type: application/json

{
  "username": "john_doe",
  "email": "john@example.com",
  "password": "secure_password123",
}
Response(201 Created):
{
    "id": 5,
   "username": "john_doe",
   "email": "john@example.com"
}

User Login

POST /api/users/login/
Content-Type: application/json

{
  "username": "john_doe",
  "password": "secure_password123",
}

Response(200 ok):
{
    "refresh": "9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b",
    "access": "9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b"
}

User Profile

GET /api/users/id=2/
{
    "id": 5,
   "username": "john_doe",
   "email": "john@example.com"
}

List All Book

GET /api/books/
Retrive all books

[
    {
        "id": 17,
        "title": "The wave",
        "genre": "Programming",
        "description": "A deep dive into advanced Python concepts.",
        "author": [
            "jasi",
            "jiju"
        ],
        "publication_date": "2025-08-11"
    },
    {
        "id": 18,
        "title": "The waves",
        "genre": "Programmingss",
        "description": "A deep dive into advanced Python concepts.",
        "author": [
            "jasi",
            "jiju"
        ],
        "publication_date": "2025-08-11"
    },
    {
        "id": 11,
        "title": "The Sic artist",
        "genre": "Psycology",
        "description": "A deep dive into advanced Sycology concepts.",
        "author": [
            "jasi"
        ],
        "publication_date": "2025-08-09"
    },
    {
        "id": 15,
        "title": "The Si artist",
        "genre": "Psycology",
        "description": "A deep dive into advanced Sycology concepts.",
        "author": [
            "jasi"
        ],
        "publication_date": "2025-08-09"
    }
]

My Books

GET /api/books/
Retrive all books

[
    {
        "id": 17,
        "title": "The wave",
        "genre": "Programming",
        "description": "A deep dive into advanced Python concepts.",
        "author": [
            "jasi",
            "jiju"
        ],
        "publication_date": "2025-08-11"
    },
    {
        "id": 18,
        "title": "The waves",
        "genre": "Programmingss",
        "description": "A deep dive into advanced Python concepts.",
        "author": [
            "jasi",
            "jiju"
        ],
        "publication_date": "2025-08-11"
    },
]

Create Book

POST /api/books/
Authorization: Token <your-token>
Content-Type: application/json

{
  "title": "The Great Gatsby",
  "authors": ["F. Scott Fitzgerald"],
  "genre": "Fiction",
  "description": "A classic American novel set in the Jazz Age."
}

Response:

{

    "message:Successfully added"

}

Edit Book

PATCH /api/books/<book_id>/
Authorization: Bearer <access-token>
Content-Type: application/json

{
  "title": "The Great Gatsby - Updated"
}

Response:
{
  "message": "Book updated successfully"
}

Delete Book

DELETE /api/book-management/

{
 "book_id":5
}

Response(200 Ok)

{

    "message: "Book deleted successfully"

}

Get Reading Lists

GET /api/reading-list/
Authorization: Bearer <access-token>

{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 1,
            "name": "The jothish",
            "description": "A deep dive into advanced Sycology concepts."
        }
    ]
}

Create Reading List

POST /api/reading-lists/
Authorization: Token <your-token>
Content-Type: application/json

{
  "name": "Summer Reading 2024",
  "description": "Books to read during summer vacation"
}

Response:
{
  "message": "Reading list created"
}

Update Reading List

PATCH /api/reading-list/7/
Authorization: Bearer <access-token>
Content-Type: application/json

{
  "name": "The Jothish Calicut",
  "description": "A deep dive into advanced Psychology concepts."
}

Response:
{
  "message": "Reading list updated"
}

Delete Reading List

GET /api/list-book/5/
Authorization: Bearer <access-token>

Response:
{
"message": "Reading list deleted"
}

Get Books in Reading List

DELETE /api/reading-list/7/
Authorization: Bearer <access-token>

Response:
[
    {
        "id": 1,
        "name": "The jothish",
        "description": "A deep dive into advanced Sycology concepts.",
        "reading_list_book": [
            {
                "book": {
                    "id": 1,
                    "title": "The waves of lands of india",
                    "genre": "Programmingss",
                    "description": "A deep dive into advanced Python concepts.",
                    "author": [
                        "jasi",
                        "ju"
                    ],
                    "publication_date": "2025-08-19"
                },
                "order": 1,
                "id": 1
            }
        ]
    }
]

Add Book to Reading List

POST /api/list-book-management/
Authorization: Bearer <access-token>
Content-Type: application/json

{
  "reading_list": 5,
  "book": 11
}

Response:
{
  "message": "Book added to reading list"
}

Update Book Order in Reading List

PATCH /api/list-book-management/
Authorization: Bearer <access-token>
Content-Type: application/json

{
  "reading_list_book": 10,
  "order": 5
}

Response:
{
  "message": "Book order updated"
}

Remove Book from Reading List

DELETE /api/list-book-management/
Authorization: Bearer <access-token>
Content-Type: application/json

{
  "reading_list": 5,
  "book": 11
}

Response:
HTTP/1.1 204 No Content

Project Structure

book-management-api/
├── manage.py
├── requirements.txt
├── .env
├── book_management/
│   ├── __init__.py
│   ├── settings.py
│   ├── urls.py
│   └── wsgi.py
├── apps/
│   ├── users/
│   ├── books/
│   └── reading_lists/

Contributing

1. Fork the repository
2. Create feature branch (git checkout -b feature/new-feature)
3. Commit changes (git commit -am 'Add new feature')
4. Push to branch (git push origin feature/new-feature)
5. Create Pull Request

Support

For questions or issues, please create an issue in the repository or contact [your-email@example.com].