Task-Manager-RESTful-API-using-Java

This is a simple RESTful API for managing tasks built with Java (Spring Boot) and MySQL. It allows you to perform CRUD (Create, Read, Update, Delete) operations on tasks. Each task has properties such as title, description, and status.

Table of Contents

• Features
• Prerequisites
• Installation
• Usage
• API Endpoints

Features

• Create a new task with title, description, and status.
• Read all tasks.
• Update the status of an existing task by ID.
• Delete a task by ID.

Prerequisites

• Before you begin, ensure you have met the following requirements:
• Java Development Kit (JDK) 8 or higher installed.
• Apache Maven for building the project.
• MySQL database server with a assignment.task database and task table set up. You can find the schema in the Database Setup section.

Installation

• Clone the repository:

  git clone https://github.com/SDEParag/Task-Manager-RESTful-API-using-Java.git

• Navigate to the project directory:

  cd Task-Manager-RESTful-API-using-Java

• Build the project using Maven:

  mvn clean install

Usage:

• Run the Spring Boot application:

mvn spring-boot:run

• Once the application is running, you can use tools like Postman to interact with the API. The API will be available at http://localhost:8080/tasks.

• Please make sure you have the necessary prerequisites (Java, Maven, etc.) installed on your system to successfully build and run the project. Additionally, ensure that your project's dependencies are correctly configured as specified in your project's pom.xml file.

API Endpoints

• The application is configured to run on port 8080 by default. Please ensure that you use the correct port number when making API requests. If you need to change the port number, you can do so by modifying the server.port property in the application.properties file.
• Server Port Configuration server.port=8080

Create a Task

- Method: `POST` : http://localhost:8080/tasks
Select -> Body -> Row -> JSON

{
    "title": "Task 1",
    "description": "Description for Task 1",
    "status": "pending"
}

- Response:
{
    "id": 1,
    "title": "Task 1",
    "description": "Description for Task 1",
    "status": "pending"
}
  - Status Code: `201 Created`
  - Body: JSON representation of the created task.

Get All Tasks

• Description: Fetch all tasks.

 Method:  `GET` : http://localhost:8080/tasks

- Response:
{
        "id": 1,
        "title": "Task 1",
        "description": "Description for Task 1",
        "status": "pending"
}

  - Status Code: `200 OK`
  - Body: List of tasks in JSON format.

Update Task Status

• Description: Update the status of an existing task.

• URL Parameters:

  • id (Long): The unique identifier of the task.

• Request Parameters:

  • status (String): The new status for the task.

- Method: `PUT` : http://localhost:8080/tasks/1
Select -> Body -> Row -> JSON

{
    "status": "completed"
}

- Response:

{
    "title": "Task 1",
    "description": "Description for Task 1",
    "status": "completed"
}

  - Status Code: `200 OK`
  - Body: JSON representation of the updated task.

Delete Task

• Description: Delete an existing task by ID.

- Method: `DELETE`: http://localhost:8080/tasks/1

- URL Parameters:
  - `id` (Long): The unique identifier of the task.

- Response:
  - Status Code: `204 No Content`