Implementing a Book store REST API using Spring Framework for Company XYZ.
- Frontend should be able to display a list of books which contain the Name and Author's name
- Book has fields such as: ID, ISBN, Name, Author, Categories
- Frontend should be able to show, all the details of each book.
- An admin in the XYZ company should be able to add books to the store.
- The XYZ company should have the ability to know when the book was inserted and updated in the system.
- The API should be able to handle Unexpected scenarios and return to the clients.
- Java 11
- Maven 3.x
-
Open the command line in the source code folder
-
Install dependencies
$ mvn install
- Run the project
$ mvn spring-boot:run
- You can change the default port (
default port is 5050) in theapplication.propertiesfile:
server.port=5050
- [Optional] Navigate to
http://localhost:5050/consolein your browser to access the database. You can change the default credentials in theapplication.propertiesfile:
spring.datasource.username=user
spring.datasource.password=password
GET /book - get all books (abstract book for adding to shelf later)
Example Request
localhost:5050/book
Example Response
[
{
"id": 1,
"name": "Magna a neque",
"price": 4656.0,
"publishedYear": 2002,
"category": "Action and Adventure",
"description": "Vestibulum ut eros non enim commodo hendrerit. Donec porttitor tellus",
"authors": [
{
"id": 3,
"firstName": "Germane",
"lastName": "Mckee",
"birthDate": "1960-04-23",
"createdAt": "2020-08-07 14:12:01",
"updatedAt": null
},
{
"id": 1,
"firstName": "Erica",
"lastName": "French",
"birthDate": "1951-10-15",
"createdAt": "2019-09-23 13:30:52",
"updatedAt": "2019-04-18 19:22:38"
},
{
"id": 4,
"firstName": "Kylee",
"lastName": "Diaz",
"birthDate": "1977-09-19",
"createdAt": "2019-02-02 05:55:11",
"updatedAt": null
}
],
"createdAt": "2019-06-29 14:09:18",
"updatedAt": "2019-05-12 09:52:17"
}
]POST /book - create a book (abstract book, this doesn't add book to the shelf)
{
"name": "Some Book",
"price": 1,
"publishedYear": 2002,
"category": "Action and Adventure",
"description": "Vestibulum ut eros non enim commodo hendrerit. Donec porttitor tellus",
"authors": [
1
],
"createdAt": "2019-06-29 14:09:18",
"updatedAt": "2019-09-12 09:52:17"
}Example Response
{
"id": 1
}PATCH /book - update a book
{
"id":1,
"name": "Updated book",
"price": 1,
"publishedYear": 1995,
"category": "Action and Adventure",
"description": "Vestibulum ut eros non enim commodo hendrerit. Donec porttitor tellus",
"authors": [
1
],
"createdAt": "2019-06-29 14:09:18",
"updatedAt": "2019-09-12 09:52:17"
}Example Response (No Response body)
HTTP 200 OK
DELETE /book?:id - delete a book
localhost:5050/book?id=1
Example Response (No Response body)
HTTP 200 OK
GET /author - return all the authors
Example Request
localhost:5050/author
Example Response
[
{
"id": 1,
"firstName": "Erica",
"lastName": "French",
"birthDate": "1951-10-15",
"books": [],
"createdAt": "2019-09-23 13:30:52",
"updatedAt": "2019-04-18 19:22:38"
},
{
"id": 2,
"firstName": "Karleigh",
"lastName": "Donovan",
"birthDate": "1945-01-23",
"books": [
{
"id": 2,
"name": "Nulla aliquet",
"price": 3807.0,
"publishedYear": 1967,
"category": "Mystery",
"description": "Integer in magna. Phasellus dolor elit, pellentesque a, facilisis non, bibendum",
"createdAt": "2019-09-11 20:17:47",
"updatedAt": "2020-07-10 11:56:59"
}
],
"createdAt": "2019-10-17 23:54:56",
"updatedAt": "2019-09-08 07:47:09"
}
]
POST /author - create a new author
{
"firstName": "Ehtiram",
"lastName": "Abdullayev",
"birthDate": "1951-10-15"
}Example Response
{
"id": 1
}GET /author/:id - get the author with the given id
Example Request
localhost:5050/author/1
Example Response
{
"id": 1,
"firstName": "Ehtiram",
"lastName": "Abdullayev",
"birthDate": "1951-10-15",
"books": [],
"createdAt": "2020-02-09 04:06:47",
"updatedAt": "2020-02-09 04:06:47"
}DELETE /book?:id - delete an author
localhost:5050/author?id=1
Example Response (No Response body)
HTTP 200 OK
Book related endpoints (adding book to shelf in the store, removing and updating book from the store shelf )
GET /bookShelf - get all the books in the store
Example Request
localhost:5050/bookShelf
Example Response
[
{
"id": 1,
"isbn": "9780134550107",
"book": {
"id": 2,
"name": "Nulla aliquet",
"price": 3807.0,
"publishedYear": 1967,
"category": "Mystery",
"description": "Integer in magna. Phasellus dolor elit, pellentesque a, facilisis non, bibendum",
"authors": [
{
"id": 2,
"firstName": "Karleigh",
"lastName": "Donovan",
"birthDate": "1945-01-23",
"createdAt": "2019-10-17 23:54:56",
"updatedAt": "2019-09-08 07:47:09"
},
{
"id": 5,
"firstName": "Juliet",
"lastName": "Hart",
"birthDate": "1955-02-02",
"createdAt": "2019-02-02 05:55:11",
"updatedAt": "2020-05-06 13:29:29"
}
],
"createdAt": "2019-09-11 20:17:47",
"updatedAt": "2020-07-10 11:56:59"
},
"bookAddedToShelfAt": "2020-02-09 04:23:31",
"bookAtShelfUpdatedAt": "2020-02-09 04:23:31"
}
]POST /bookShelf - add a new book to the shelf in store, returns id of newly created book
{
"bookId": 2,
"isbn": 9780134550107
}Example Response
{
"id": 1
}POST /bookShelf/book/name - search the book with the given name in request body
{
"bookName": "que"
}Example Response
{
"bookStocks": [
{
"id": 1,
"isbn": "9780134550107",
"book": {
"id": 2,
"name": "Nulla aliquet",
"price": 3807.0,
"publishedYear": 1967,
"category": "Mystery",
"description": "Integer in magna. Phasellus dolor elit, pellentesque a, facilisis non, bibendum",
"authors": [
{
"id": 2,
"firstName": "Karleigh",
"lastName": "Donovan",
"birthDate": "1945-01-23",
"createdAt": "2019-10-17 23:54:56",
"updatedAt": "2019-09-08 07:47:09"
},
{
"id": 5,
"firstName": "Juliet",
"lastName": "Hart",
"birthDate": "1955-02-02",
"createdAt": "2019-02-02 05:55:11",
"updatedAt": "2020-05-06 13:29:29"
}
],
"createdAt": "2019-09-11 20:17:47",
"updatedAt": "2020-07-10 11:56:59"
},
"bookAddedToShelfAt": "2020-02-09 04:23:31",
"bookAtShelfUpdatedAt": "2020-02-09 04:23:31"
}
],
"numberOfBooks": 1
}PATCH /bookShelf - update a book in the shelf
{
"id":1,
"isbn":9781402894626
}Example Response (No Response body)
HTTP 200 OK
DELETE /bookShelf?:id - remove a physical book from the shelf
http://localhost:5050/bookShelf?id=1
Example Response (No Response body)
HTTP 200 OK