rcarvalho-pb/backend-todo-app-java

To Do Application BackEnd Java

This project is an API using Java and Spring Boot

Table of Contents

• Installation
• Configuration
• Usage
• API Endpoints

Installation

1. Clone the repository

git clone https://github.com/rcarvalho-pb/backend-todo-app-java.git

Usage

1. Start the application with:

./mvnw spring-boot:run

2. The API will be accessible at http:localhost:8080

API Endpoints

Documentation via swagger can be accessed by the url: localhost:8080/swagger-ui/index.html

The API provides the following endpoints:

###Create To Do activity

POST /api/v1/todos/create - Create and save a new to do activity

Body

{
    "name": "Test",
    "description": "Test",
    "done": false,
    "priority": 0
}

###Get All To Do Activities

GET /api/v1/todos - Get All saved to do activities

###Find one To Do Activity by ID

GET /api/v1/todos/{id} - Find a saved to do activity by it's id

###Update a To Do Activity

PUT /api/v1/todos/{id} - Update a To Do activity by it's id

Body

{
    "name": "Test",
    "description": "Test",
    "done": false,
    "priority": 0
}

###Delete To Do Activity by ID

DELETE /api/v1/todos/{id} - Delete a To Do activity by id