Below you will find the 3 user stories that are implemented in this Application.
Create schema, which will allow storing different products and categories. Keep in mind that getting full category path for the product might be a requirement in the future. Currency for product price is EUR. You can choose any RDBMS.
A client should be able to perform CRUD operations for Product and Category resources. Add an ability to create products with price in different from EUR currency. Integrate the system with some open currency exchange rates API (for example http://fixer.io) Use Spring as a core framework. Use JPA/ORM Use Spring MVC. Any other technologies / libraries can be chosen on your own.
Add Spring Security support. Add a "super" user.
- A product might be associated to multiple categories. For instance, an electric toothbrush may belong to both "Electronics" and "Beauty & Personal Care" categories.
- There are some fields that for simplicity we are not having in Product table such as description, features, price discount, refurbished, among others.
- Products belong to Users. Only the creating user is able to update or delete Products, but all Users can see products present in the system.
It's important to note that this is a HATEOAS-oriented REST API. That means you will find some URLs in the API response referencing to possible actions that can be performed on the resource.
It's highly recommendable to take a look at the unit tests defined in com.github.damiox.ecommerce.api.controller to understand the expected API responses from a Development perspective.
Currently there are two roles defined as follows:
- ADMIN: it's the super user role that can manipulate categories and products.
- USER: it's a user role that can manipulate only products that were created by that user. It can also get data for other users products and categories in the system.
curl -H "Content-Type: application/json" -X POST "http://localhost:8080/login" -d '{ "username": "admin", "password": "admin" }'
curl -H "Content-Type: application/json" -X POST "http://localhost:8080/login" -d '{ "username": "user1", "password": "user1" }'
curl -H "Content-Type: application/json" -X POST "http://localhost:8080/login" -d '{ "username": "user2", "password": "user2" }'
Excepting the /login API endpoint that is being used for authentication, all the other API endpoints require a HTTP header to be passed in as parameter in all requests.
This HTTP header will have the key name "Authorization" and the key value will be the authentication token that was retrieved during the authentication transaction (please see the Authentication section).
Note: this token is a JWT token that is internally signed with a private key configured in the server, and it has the public user information on it.
The idea behind this JWT token is to avoid going back to the database to validate whether a JWT token is valid or not, because that information is already contained in the token itself.
There are several approaches for authentication such as Cookies, GUID tokens, OAuth2, etc... but we are choosing JWT for simplicity and scalability purposes.
Note: we are using HATEOAS-oriented REST endpoints (https://en.wikipedia.org/wiki/HATEOAS), so you will find the possible operations to perform on resources while browsing the main endpoints: /products and /categories
In the below examples, you need to replace XXXX with the token returned in the authentication process (please see the Authentication section for more information).
The list of Products is always a paginated result for scalability.
URL: /products
- To get (paged) list of products:
curl -H "Authorization: XXXX" -X GET "http://localhost:8080/products" - To get products info:
curl -H "Authorization: XXXX" -X GET "http://localhost:8080/products/{id}" - To create products:
curl -H "Content-Type: application/json" -H "Authorization: XXXX" -X POST "http://localhost:8080/products" -d '{ "name": "P1", "currency": "EUR", "price": 100.00 }' - To update products:
curl -H "Content-Type: application/json" -H "Authorization: XXXX" -X PUT "http://localhost:8080/products/{id}" -d '{ "name": "P1", "currency": "EUR", "price": 100.00 }' - To delete products:
curl -H "Authorization: XXXX" -X DELETE "http://localhost:8080/products/{id}"
URL: /categories
- To get list of categories:
curl -H "Authorization: XXXX" -X GET "http://localhost:8080/categories" - To get category info:
curl -H "Authorization: XXXX" -X GET "http://localhost:8080/categories/{id}" - To create category:
curl -H "Content-Type: application/json" -H "Authorization: XXXX" -X POST "http://localhost:8080/categories" -d '{ "name": "C1" }' - To update category:
curl -H "Content-Type: application/json" -H "Authorization: XXXX" -X PUT "http://localhost:8080/categories/{id}" -d '{ "name": "C1" }' - To delete category:
curl -H "Authorization: XXXX" -X DELETE "http://localhost:8080/categories/{id}"
- To associate / dis-associate a child category with / from a parent category you can use the following URL:
/categories/{parentid}/subcategories/{childid} - To see the current child categories for a given category, you can do a GET on
/categories/{parentid}/subcategories
- To link / unlink products with categories you can use the following URL:
/categories/{categoryid}/products/{productid} - To see the current products for a given category, you can do a GET on
/categories/{parentid}/products. Note: the API will return also products that are being associated indirectly. That means if a Product is associated with Category B, which is in turn a child of Category A, then the product is directly associated with Category B, and indirectly associated with Category A. Accessing to/categories/A/productswill return that product that is associated with Category A indirectly along with the products being associated directly with the Category A.
- Java 8
- Spring Boot
- Spring Web / MVC
- H2 (in-memory database)
- Spring Data (JPA)
- Hibernate (ORM)
- Spring HATEOAS