This repository contains a simple API RESTful project built using Java Spring. The aim of this repository is to practice and share how you can build a API using Java Spring.
- Clone the repository:
$ git clone [email protected]:VidalGuilherme/todo-list-spring.git
- Install dependencies with Maven
- Start the application with Maven
- The API will be accessible at http://localhost:8080/api/
The API provides the following endpoints:
GET /todo_lists - Retrieve a list of all todo lists.
POST /todo_lists - Register a new todo list.
PUT /todo_lists/{id} - Alter an existing todo list.
DELETE /todo_lists/{id} - Delete an existing todo list.
GET /todo_items - Retrieve a list of all todo items.
POST /todo_items - Register a new todo item.
PUT /todo_items/{id} - Alter an existing todo item.
DELETE /todo_items/{id} - Delete an existing todo item.
The project uses PostgresSQL as the database. Spring boot to automatically load my database schema when I start it up
spring.jpa.generate-ddl=true
You can run a database for this project with Docker by running the following command:
$ docker-compose up -d
To install Docker locally you can click here.