API

API

The below API's are used to fetch the details from database and return it to the calling API so that data in FRONTEND can be rendered based on the data stored in BACKEND

1. Get Genre API
2. Get Particular Genre API
3. Get Books based on Genre
4. Insert Books into Database
5. API to return Book Details by ID
6. API to post book reviews
7. API to fetch book reviews
8. API to fetch ratings of a book by ID
9. API to Fetch the Top 5 books for a Given Genre
10. API to Register User
11. API to authenticate a user login
12. API to add a book to users wishlists

The Postman commands and sample examples can be viewed here : https://documenter.getpostman.com/view/19432934/UVeGqRHi

1. Get Genre API

http://localhost:8080/api/getGenres

Method : GET

This getGenres API is used to fetch all the Genres Present in The Genres Table from the Database.

Sample API and Sample Output

Sample Output :

Sample Demo :

2. Get Particular Genre API

localhost:8080/api/getGenres/5

Method : GET The getGenres/{id} API is used to fetch a particular Genre from the database based on the Genre ID requested from the frontend Webpage.

Sample API and Sample Output

Sample Demo :

3. API to Insert books into Database

http://localhost:8080/api/insertBook

Method Type: POST API will receive a POST request from the body in JSON format. This JSON is Decoded to a struct type Book and insert the values into database books.db books table as per the user's request.

Sample API usage via POSTMAN

After the insertion API will return values in JSON format of the information inserted in DB and the ID generated for the book.

Sample Demo :

4. API to fetch Books from the Database tagged with requested GenreID

http://localhost:8080/api/fetchGenreBooks?id=5

Method : GET API will receive a request with Genre ID query in URL string and returns a array of all the books in DB tagged with the requested Genre ID in JSON format.

Sample API usage via POSTMAN

Sample Demo :

5. API to return Book Details by ID

http://localhost:8080/api/getBook?id=5

Method : GET The /api/getBook API is used to fetch a particular Book by its ID as requested from the frontend Webpage.

Sample API usage and Output

6. API to post book reviews

http://localhost:8080/api/addReviews

Method Type: POST API will receive a POST request from the body in JSON format. This JSON is Decoded to a struct type Reviews and insert the values into database books.db books table as per the user's request.

1. It will insert the review datas to Review table as and when any user writes Reviews about the book.
2. It also calculates the review and ratin g count and increments it in the Book Table.

Sample API usage via POSTMAN

After the insertion API will return values in JSON format of the information inserted in DB and the ID generated for the book review.

7. API to fetch book reviews

http://localhost:8080/api/retrieveReviews?rindex=9&BookId=6

Method Type: GET API will receive a GET request from the body in JSON format. This JSON is Decoded to a struct type Review and insert the values into database books.db books table as per the user's request. This API returns top 10 the reviews for that particular BookID. And based on the Review-Index, it returns the next 10 revies starting from index number Review-index

Sample API usage via POSTMAN

8. API to fetch ratings of a book by ID

http://localhost:8080/api/fetchBookRatings?id=2

Method Type: GET API will receive a GET request from the body in JSON format. This JSON is Decoded to a struct type Book and insert the values into database books.db books table as per the user's request.

Sample API usage via POSTMAN

9. API to Fetch the Top 5 books for a Given Genre

http://localhost:8080/api/fetchTopBooksForGenre?id=5

Method Type: GET The /fetchTopBooksForGenre?id=5 API is used to fetch the top 5 Books for any given Genre ID

Sample API usage and Output

10. API to Register User

http://localhost:8080/api/signUp

Method Type : POST This API is to register a new user account.

Sample API usage and output

11. API to authenticate User login

http://localhost:8080/api/login

Method Type : POST This api will authenticate users email and password and return a json body that contains the status(true / false).

Sample API usage and output

12. API to add a book to users wishlists

http://localhost:8080/api/addMyBooks

Method Type : POST

This api will associate book ids when a user adds a book to his/her wishlist based on users id.

Sample API usage and output