Skip to content

Commit 836f293

Browse files
committed
chore: readme file updated
1 parent c5eb514 commit 836f293

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

readme.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,19 @@ Bookly is an innovative online platform designed for book lovers to connect and
4040
- **Create and Update:** User can create new categories and update the categories created by them.
4141
- **Get and List:** Users can list all categories or get a specific genre details by genre name.
4242

43+
### Book
44+
45+
- **Create Book:** Users can submit a book for sharing, including details such as title, author, description, category and genre.
46+
- **Update Book:** Users can modify existing book details, including the description and other attributes.
47+
- **List Books:** Users can view a comprehensive list of all books posted by all users in a user-friendly format.
48+
- **Get Book By ISBN:** Users can retrieve a book's details by entering its unique ISBN number for precise identification.
49+
- **Get Book By UID:** Users can access specific book information using the unique identifier (UID) assigned to each book.
50+
- **Get Book By Title:** Users can search for books by entering the title for quick access to relevant titles.
51+
- **List Books by Category:** Users can browse books organized by predefined categories for easier navigation.
52+
- **List Books by Genre:** Users can explore books categorized by genre, making it simple to find specific types of literature.
53+
- **List Books by Author:** Users can filter and view books authored by a specific individual, streamlining the search for fans.
54+
- **Update Book Images:** Users can upload or replace images for a book, with a maximum limit of five images per book.
55+
4356
## Technologies Used
4457

4558
- **Backend Framework:** FastAPI
@@ -113,6 +126,19 @@ This command will build the necessary services and start the application, includ
113126
- **Get Genre By Genre Name:** `GET /books/genre/get/{genre}`
114127
- **List All Categories:** `GET /books/genre/list`
115128

129+
### Book Endpoints
130+
131+
- **Create Book:** `POST /books/create`
132+
- **Update Book:** `PATCH /books/update/{book_uid}`
133+
- **List Books:** `GET /books/list`
134+
- **Get Book By ISBN:** `GET /books/get/isbn/{isbn}`
135+
- **Get Book By UID:** `GET /books/get/uid/{book_uid}`
136+
- **Get Book By Title:** `GET /books/get/title/{title}`
137+
- **List Books by Category:** `GET /books/list/category/{category}`
138+
- **List Books by Genre:** `GET /books/list/genre/{genre}`
139+
- **List Books by Author:** `GET /books/list/author/{author}`
140+
- **Update Book Images:** `PATCH /update/images/{book_uid}`
141+
116142
## API Documentation
117143

118144
You can find the full API documentation at `http://localhost:8000/api/v1/docs`, generated using Swagger UI.

0 commit comments

Comments
 (0)