Spring boot basic structure

Spring boot project for beginner level

Tech Stack

Server: Java, Java Spring boot, JPA, lombok,

Database: Mysql

Installation

Clone project from github

  git clone [email protected]:Nathapons/spring-boot-basic-structure.git
  cd spring-boot-basic-structure

Set up application.yml. If you don't have please create the file in /src/main/resources

spring:
  datasource:
    url: jdbc:mysql://<your-database-host>:<your-database-port>/<your-database-name>
    username: <your-database-username>
    password: <your-database-password>

  jpa:
    show-sql: true
    generate-ddl: true
    properties:
      hibernate:
        dialect: org.hibernate.dialect.MySQL8Dialect
    hibernate:
      ddl-auto: update

server:
  port: <your-port>

Running application

To run tests, run the following command

  mvn spring-boot:run

or

  mvn clean spring-boot:run

Remark: Please make sure your running at Demo1Application.java

Entity (Database schema)

User entity

Parameter	Type	Json	Description
id	long	id	user id
firstName	string	first_name	first name of user
lastName	string	last_name	last name of user
age	int	age	age of user

Address entity

Parameter	Type	Json	Description
id	long	id	address id
street	string	street	-
city	string	city	-
zipCode	int	zip_code	-
user	int	user	user id which is relate with user

User API Reference

Get all users

  GET /apis/v1/users

Get user by id

  GET /api/user/{id}

Parameter	Type	Description
id	string	Required. Id of user to fetch

Create user

  POST /api/users

Request body	Type	Description
first_name	string	Required. first name of user
last_name	string	Required. last name of user
age	int	Required. age of user

Update user by id

  PUT /api/user/{id}

Parameter	Type	Description
id	string	Required. Id of user to fetch

Request body	Type	Description
first_name	string	Required. first name of user
last_name	string	Required. last name of user
age	int	Required. age of user

Delete user by id

  DELETE /api/user/{id}

Parameter	Type	Description
id	string	Required. Id of user to fetch

Address API Reference

Get all address

  GET /apis/v1/address

Get address by id

  GET /api/address/{id}

Parameter	Type	Description
id	string	Required. Id of address to fetch

Create address

  POST /api/address

Request body	Type	Description
street	string	Required.
city	string	Required.
zip_code	string	Required.
user	int	Required. user id of user entity

Update address by id

  PUT /api/address/{id}

Parameter	Type	Description
id	string	Required. Id of address to fetch

Request body	Type	Description
street	string	Required.
city	string	Required.
zip_code	string	Required.
user	int	Required. user id of user entity

Delete address by id

  DELETE /api/address/{id}

Parameter	Type	Description
id	string	Required. Id of address to fetch