Skip to content

felype-carvalho/spring-api-crud

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 

Repository files navigation

CRUD Spring API

Summary
  1. About the Project
  2. How to use
  3. License

About the project

The project is a REST API with CRUD functionality for the person and address objects. Where the relationship works like many addresses for one person.

The API also has validation for duplicate email and CPF and use H2 Database was used for data persistence.


Build With

The technologies used in this project were:


Visual


How to Use

Prerequisites

JDK 17, Maven and Git


Installation via terminal

1- Clone this repository.

git clone https://github.com/felype-carvalho/spring-api-crud.git

2- Access the project folder in your terminal/cmd.

cd spring-api-crud/crud-spring-api

3- Run the application with Maven.

mvn spring-boot:run

4- Open http://localhost:8080/ in the browser and watch the project run.


Installation via IDE

This installation method works without installing Maven.

1- Clone this repository.

git clone https://github.com/felype-carvalho/spring-api-crud.git

2- Access the project folder in your Java IDE.

3- Run CrudSpringApiApplication.java file.

4- Open http://localhost:8080/ in the browser and watch the project run.


Documentation

This project was created using Swagger to generate the API documentation. With the project running, you can access the documentation at the links below:

http://localhost:8080/swagger-ui/index.html
http://localhost:8080/swagger-ui

License

Distributed under the MIT license. See LICENSE for more information.

About

A CRUD using Spring API

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages