/SpringBootEcommerceApiJersey

Ecommerce Api application built with Spring Boot + JAX-RS Jersey

Primary LanguageJava

Spring Boot + Jax-RS jersey E-commerce

Table of Contents

Introduction

This is one of my E-commerce API app implementations. It is written in Java using Spring Boot, Hibernate and Jersey as the main dependencies. This is not a finished project by any means, but it has a valid enough shape to be git cloned and studied if you are interested in this topic. If you are interested in this project take a look at my other server API implementations I have built(see below).

Full-stack Applications

E-commerce (shopping cart)

Server side implementations

The next to come are:

  • Spring Boot + Spring Data Hibernate + Kotlin
  • Spring Boot + Jax-RS Jersey + Hibernate + Kotlin
  • Spring Boot + mybatis
  • Spring Boot + mybatis + Kotlin
  • Asp.Net Web Api v2
  • Elixir
  • Golang + Beego
  • Golang + Iris
  • Golang + Echo
  • Golang + Mux
  • Golang + Revel
  • Golang + Kit
  • Flask + Flask-Restful
  • AspNetCore + NHibernate
  • AspNetCore + Dapper

Client side implementations

This client side E-commerce application is also implemented using other client side technologies:

Blog/CMS

Server side implementations

The next to come are:

  • Spring Boot + Spring Data Hibernate + Kotlin
  • Spring Boot + Jax-RS Jersey + Hibernate + Kotlin
  • Spring Boot + mybatis
  • Spring Boot + mybatis + Kotlin
  • Asp.Net Web Api v2
  • Elixir
  • Golang + Beego
  • Golang + Iris
  • Golang + Echo
  • Golang + Mux
  • Golang + Revel
  • Golang + Kit
  • Flask + Flask-Restful
  • AspNetCore + NHibernate
  • AspNetCore + Dapper

Client side

The next come are

  • Angular NgRx-Store
  • Angular + Material
  • React + Material
  • React + Redux + Material
  • Vue + Material
  • Vue + Vuex + Material
  • Ember

Simple CRUD(Create, Read, Update, Delete)

Server side implementations

Client side implementations

The next come are

  • Angular NgRx-Store
  • Angular + Material
  • React + Material
  • React + Redux + Material
  • Vue + Material
  • Vue + Vuex + Material
  • Ember
  • Vanilla javascript

CRUD + Pagination

Server side implementations

The next come are

  • NodeJs Express + Knex
  • Flask + Flask-Restful
  • Laravel + Fractal
  • Laravel + ApiResources
  • Go with Mux
  • AspNet Web Api 2
  • Jersey
  • Elixir

Client side implementations

The next come are

  • Angular NgRx-Store
  • Angular + Material
  • React + Material
  • React + Redux + Material
  • Vue + Material
  • Vue + Vuex + Material
  • Ember
  • Vanilla javascript

Social media links

  • Youtube Channel I publish videos mainly on programming
  • Blog Sometimes I publish the source code there before Github
  • Twitter I share tips on programming

WARNING

I have mass of projects to deal with so I make some copy/paste around, if something I say is missing or is wrong, then I apologize and you may let me know opening an issue.

Getting started

As with most node js projects, do the following

  1. git clone
  2. open src/java/resources/application.yml and change the database info to yours, and ddl-auto to create
  3. Then to seed you have to pass seeds as the first argument to the application, in intelliJ it is done easily, just go to Run > Edit Configuration, copy the run config for the default Spring Boot application which automatically appeared in IntelliJ, now move to copied configuration change the name to whatever you want, expand the Environment tree, and add write seeds in program arguments:

Fetching products page

  1. Then switch back to application.yml change dd-auto to update, change the run config to the default, and run the app. If you did not understood the above steps, then it is easy, go to DbSeeder.java, comment this: @Profile("seeds") and run the app, you don't have to pass any args, the seeding process will always run, but don't worry, the seeding code checks if it has seeded before and only seeds if it does not.

  2. You can also open the api.postman_collection.json file in postman and begin issuing requests

Features

  • Authentication / Authorization
  • Paging
  • Admin feature (incomplete)
  • CRUD operations on products, comments, tags, categories Fetching products page
  • Orders, guest users may place an order Database diagram

What you will learn

  • Spring Boot

  • Jersey

  • Spring Web

    • JWT
    • Controllers
    • Filters

  • Spring Security

  • Spring Data

  • Hibernate ORM

    • associations: ManyToMany, OneToMany, ManyToOne
    • transient fields
    • complex queries

  • seed data with faker

  • misc

    • project structure

Understanding the project

The project is meant to be educational, to learn something beyond the hello world thing we find in a lot, lot of tutorials and blog posts. Since its main goal is educational, I try to make as much use as features of APIs, in other words, I used different code to do the same thing over and over, there is some repeated code but I tried to be as unique as possible so you can learn different ways of achieving the same goal.

Project structure:

  • models: Mvc, it is our domain data.
  • dtos: it contains our serializers, they will create the response to be sent as json. They also take care of validating the input(feature incomplete)
  • controllers: well this is the mvC, our business logic.
  • config: the web and security configurers.
  • seeds: contains the file that seeds the database.
  • uploads: a folder that will be generated when you create a product or tag or category with images
  • errors: it contains the app exception handler and some custom exception classes
  • services: contains some business logic for each model, and for authorization
  • repositories: perform the crud operations on the database using Spring Data repositories
  • annotations: contains an annotation used for confirming password and password confirmation

TODO

  • Security config antMatchers + hasRole(ADMIN) does not work, I have to use PreAuthorize as a workaround
  • Make it more Jersey like project, for example implement Jwt using pure Jax RS
  • For the moment I have not filtered any input, the next commit will sanitize any input from untrusted users.
  • Delete Product feature, does not work because of FK issues
  • Improve SQL query:
    • get Orders
    • getting product associations, it must to join instead of fetching everything in a separate query
  • OrderControllers::checkout() does not work with @Valid, fix
  • Show how many times a product was bought in Product JSON List and details
  • It is cool to use slug for urls for pretty urls but, for POST/PUT/DELETE requests it is better to use Ids for performance so we can retrierve the Hibernate Proxy, anyways, the client side app will not show the ugly /users/:pid/comments/:id url
  • Write a validation routine for CheckoutDto, it has to validate depending on if addressId is set or not. if it is set, we have to use it.
  • Improve User Responses, return orders count, comments count
  • Refactor the ErrorResponse parsing, it should take only meaningful messages from bindingResult.getModel() otherwise app crashes ..
  • Change authorization logic from Enum based(AuthorizationPolicy) to role name based (incomplete)

Resources