This is a simple backend implemented using the spring boot framework and hosting a REST API for web clients.
- User authentication
- CRUD on products and carts
- MongoDB database
The shopping cart uses the following technologies to work:
- Java 1.8
- Built with gradle 3.5
- MongoDB database with default config mongodb://127.0.0.1:27017.
- SpringBoot framework
- For the moment, the project uses only the default test database from the MongoRepository.
- All the repositories are flushed on application start, this is done in the ShoppingcartApplication class, comment this: cartUserRepository.deleteAll(); productRepository.deleteAll(); shoppingCartRepository.deleteAll(); at the lines 59 to 61.
- Default users are set in the db on application start, uname: alice, psw: toto, uname: toto, psw: toto
- Default products are also set in the db on application start.
- There is no possibility to add nor delete a product (you can update them with a form) on the UI side but this backend provides an endpoint for this (could be used by an admin user for instance).
- spring-boot-starter
- spring-boot-starter-web:1.5.7.RELEASE
- spring-boot-starter-data-mongodb
- spring-boot-starter-security
- io.jsonwebtoken:jjwt:0.7.0
ShoppingCart requires Java 1.8 to run and is built with gradle 3.5.
Make sure you have a mongo database server up and running on the default port, if not
$ sudo apt-get install mongodb-org
$ sudo service mongod start
Build with gradle and start the server.
$ cd shoppingcart
$ ./gradlew build
$ ./gradlew bootRunOr
$ cd shoppingcart
$ ./gradlew build
$ java -jar build/libs/shoppingcart-0.0.1-SNAPSHOT.jarThis API is a JSON RESTful API. The client is expected to send
application/json as Content-Type and a json web token (format: Bearer <token>) as Authorization HTTP Header and JSON formatted bodies.
POST /users/signup
Registers a user
$ curl -i -H "Content-Type: application/json" -X POST -d '{"userName":<uname>, "password":<psw>, "email": <email>}' http://localhost:8080/users/signup
The user has been successfully registered
POST /login
Registers a user
$ curl -i -H "Content-Type: application/json" -X POST -d '{"userName":<uname>, "password":<psw>}' http://localhost:8080/users/signup
login successful and token located in 'Authorization' header with the format explained above
GET /users
Gets the users list
$ curl -i -H "Content-Type:application/json" -H "Authorization:<token>" -X GET http://localhost:8080/users
fetched users list, example response:
[
{
"id":"59d8a05d479ded183906fa3d",
"firstName":"Alice",
"lastName":"Smith",
"userName":"alice",
"password":"$2a$10$W8kg2OC8URIqkHQf4f65FuAwr5YadPiIR2TISlzKEqJNU/OuBruHG",
"email":"[email protected]"
},
...
]
GET /users/{userId}
Gets a user from its Id
$ curl -i -H "Content-Type:application/json" -H "Authorization:<token>" -X GET http://localhost:8080/users/{userId}
fetched user
DELETE /users/{userId}
Deletes a user from its Id
$ curl -i -H "Content-Type:application/json" -H "Authorization:<token>" -X DELETE http://localhost:8080/users/{userId}
user deleted
POST /products
Adds a product
$ curl -i -H "Content-Type:application/json" -H "Authorization:<token>" -X POST -d '<payload>' http://localhost:8080/products
Payload to send example:
{
"productName": "sechoir",
"productCode": "SE-4320",
"releaseDate": "123123134",
"description": "sechoir pour cheveux",
"price": 19.95,
"starRating": 3.0,
"imageUrl": "http://openclipart.org/image/300px/svg_to_png/26215/Anonymous_Leaf_Rake.png"
}
product created
PUT /products/{productId}
Updates a product
$ curl -i -H "Content-Type:application/json" -H "Authorization:<token>" -X POST http://localhost:8080/products
product updated payload with new values in response
GET /products
Fetches a product list
$ curl -i -H "Content-Type:application/json" -H "Authorization:<token>" -X GET http://localhost:8080/products
product list
GET /products/{productId}
Fetches a product
$ curl -i -H "Content-Type:application/json" -H "Authorization:<token>" -X GET http://localhost:8080/products/{productId}
product payload
DELETE /products/{productId}
Deletes a product
$ curl -i -H "Content-Type:application/json" -H "Authorization:<token>" -X DELETE http://localhost:8080/products/{productId}
product deleted
GET /carts
Gets all the shopping carts
$ curl -i -H "Content-Type:application/json" -H "Authorization:<token>" -X GET http://localhost:8080/carts
shopping carts list
Response payload example:
[
{
"id":"59d89875479ded2a718bac15",
"status":"pending",
"userName":"testuser","
products":{
"59d89875479ded2a718bac13":{
"id":"59d89875479ded2a718bac13",
"productName":"colgatewhite",
"productCode":"GE-1206",
"releaseDate":1483539355570,
"lastModified":1507367029712,
"description":"dentifrice",
"price":3.95,
"starRating":4.5,"
imageUrl":"http://colgate.com/2/"
},
"59d89875479ded2a718bac14":{
"id":"59d89875479ded2a718bac14",
"productName":"gilettemousse",
"productCode":"GE-1206",
"releaseDate":1486224955570,
"lastModified":1507367029713,
"description":"moussearaser",
"price":2.95,
"starRating":4.2,
"imageUrl":"http://gilette.com/2/"
}
},
"productQuantities":{"59d89875479ded2a718bac13":1,"59d89875479ded2a718bac14":2},
"lastModified":1508080555570,
"orderDate":1508080555570,
"totalPrice":0.0
},
...
]
GET /carts/user/{userName}
Gets all the shopping carts for the given username
$ curl -i -H "Content-Type:application/json" -H "Authorization:<token>" -X GET http://localhost:8080/carts/user/{userName}
shopping carts list for the username, same format response as previous request
GET /carts/{cartId}
Gets a shopping cart from its Id
$ curl -i -H "Content-Type:application/json" -H "Authorization:<token>" -X GET http://localhost:8080/carts/{cartId}
shopping carts list for the username, same format response as previous request
POST /carts
Adds a shopping cart
$ curl -i -H "Content-Type:application/json" -H "Authorization:<token>" -X POST -d '<payload>' http://localhost:8080/carts
Payload to send example:
{
"id":"",
"status":"pending",
"userName":"testuser",
"products":{},
"productQuantities": {},
"lastModified": <epoch>,
"orderDate": <epoch>",
"totalPrice": <float>
}
shopping cart created
PUT /carts/{cartId}
Updates a shopping cart
$ curl -i -H "Content-Type:application/json" -H "Authorization:<token>" -X POST -d '<payload>' http://localhost:8080/carts/{cartId}
Payload to send example:
Same as in POST but the id attribute in the payload is mandatory
shopping cart updated
DELETE /carts/{cartId}
Deletes a shopping cart
$ curl -i -H "Content-Type:application/json" -H "Authorization:<token>" -X DELETE http://localhost:8080/carts/{cartId}
shopping cart deleted
POST /carts/{cartId}/product/{productId}
Adds a product to a shopping cart
$ curl -i -H "Content-Type:application/json" -H "Authorization:<token>" -X POST http://localhost:8080/carts/{cartId}/product/{productId}
new shopping cart payload updated with the new product
shopping cart processed but product not added because of stock too low
DELETE /carts/{cartId}/product/{productId}
Removes a product from a shopping cart
$ curl -i -H "Content-Type:application/json" -H "Authorization:<token>" -X DELETE http://localhost:8080/carts/{cartId}/product/{productId}
new shopping cart payload updated without the new product in its list or with an updated productQuantities attribute if there was more than one product
When a request is sent without the token
When an item (shopping cart, product, user) has not been found
When the item already exists, raised when a user signs up with an already existing username or email for example