From 29a127e2f677d65385c83e7e9273eea847d8690c Mon Sep 17 00:00:00 2001 From: Sylvain Monmignon Date: Mon, 7 Sep 2026 18:51:53 +0200 Subject: [PATCH] doc: documentation --- .../myapi/api/Controller/TaskController.java | 24 +++++++++++++++++-- .../java/myapi/api/Model/Enums/Status.java | 12 ++++++---- src/main/java/myapi/api/Model/Task.java | 14 +++++++---- .../myapi/api/Repository/TaskRepository.java | 4 ++++ .../java/myapi/api/Service/TaskService.java | 1 - .../myapi/api/Service/TaskServiceImpl.java | 13 +++++++++- 6 files changed, 55 insertions(+), 13 deletions(-) diff --git a/src/main/java/myapi/api/Controller/TaskController.java b/src/main/java/myapi/api/Controller/TaskController.java index 59fb2e3..d2ca261 100644 --- a/src/main/java/myapi/api/Controller/TaskController.java +++ b/src/main/java/myapi/api/Controller/TaskController.java @@ -2,10 +2,8 @@ package myapi.api.Controller; import java.util.List; import myapi.api.Model.Task; -import myapi.api.Repository.TaskRepository; import myapi.api.Service.TaskService; import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.http.ResponseEntity; import org.springframework.web.bind.annotation.DeleteMapping; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.PathVariable; @@ -15,6 +13,10 @@ import org.springframework.web.bind.annotation.RequestBody; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; +/** + * Classe servant de point d'entrée pour les objets Tâches + * TaskController + */ @RestController @RequestMapping("/task") public class TaskController { @@ -22,21 +24,39 @@ public class TaskController { @Autowired private TaskService taskService; + /** + * Récupère toutes les tâches de la bdd + * @return Une liste de Task + */ @GetMapping public List getAllTasks() { return taskService.getAllTasks(); } + /** + * Ajoute une nouvelle tâche à la bdd + * @param task L'objet tâche que l'on veut ajouter + * @return La tâche créée + */ @PostMapping("/add") public Task addTask(@RequestBody Task task) { return taskService.addTask(task); } + /** + * Modifie une tâche de la bdd + * @param task La tâche que l'on veut modifier. Il faut que son id soit déjà présent + * @return La tâche créée + */ @PutMapping("/update") public Task updateTask(@RequestBody Task task) { return taskService.updateTask(task); } + /** + * Supprime une tâche de la bdd + * @param idTask L'id de la tâche + */ @DeleteMapping("/delete/{id}") public void deleteTask(@PathVariable("id") int idTask) { taskService.deleteTask(idTask); diff --git a/src/main/java/myapi/api/Model/Enums/Status.java b/src/main/java/myapi/api/Model/Enums/Status.java index 2d04a24..5a220de 100644 --- a/src/main/java/myapi/api/Model/Enums/Status.java +++ b/src/main/java/myapi/api/Model/Enums/Status.java @@ -1,7 +1,11 @@ package myapi.api.Model.Enums; -public enum Status{ - EnCours, +/** + * Enumération des différents status possibles pour une tâche + * Status + */ +public enum Status { + En_cours, Termine, - EnRetard -} \ No newline at end of file + En_retard, +} diff --git a/src/main/java/myapi/api/Model/Task.java b/src/main/java/myapi/api/Model/Task.java index faa8ea8..aa19592 100644 --- a/src/main/java/myapi/api/Model/Task.java +++ b/src/main/java/myapi/api/Model/Task.java @@ -1,27 +1,31 @@ package myapi.api.Model; -import java.util.Date; - import jakarta.persistence.Entity; import jakarta.persistence.GeneratedValue; import jakarta.persistence.GenerationType; import jakarta.persistence.Id; import jakarta.persistence.Table; +import java.util.Date; +/** + * Classe mappée à la table task de la bdd + * Task + */ @Entity -@Table(name="task") +@Table(name = "task") public class Task { @Id @GeneratedValue(strategy = GenerationType.IDENTITY) private int id_task; - + private String name_task; private String status_task; private Date date_task; private Integer priority_task; private Integer id_group; + /* --- GETTERS ET SETTER --- */ public int getId_task() { return id_task; @@ -71,7 +75,7 @@ public class Task { this.id_group = id_group; } - public String toString(){ + public String toString() { return "id : " + this.id_group; } } diff --git a/src/main/java/myapi/api/Repository/TaskRepository.java b/src/main/java/myapi/api/Repository/TaskRepository.java index 08c1e2c..7da7442 100644 --- a/src/main/java/myapi/api/Repository/TaskRepository.java +++ b/src/main/java/myapi/api/Repository/TaskRepository.java @@ -4,5 +4,9 @@ import myapi.api.Model.Task; import org.springframework.data.jpa.repository.JpaRepository; import org.springframework.stereotype.Repository; +/** + * Repository Jpa permettant la persistance + * TaskRepository + */ @Repository public interface TaskRepository extends JpaRepository {} diff --git a/src/main/java/myapi/api/Service/TaskService.java b/src/main/java/myapi/api/Service/TaskService.java index 929b531..ae26481 100644 --- a/src/main/java/myapi/api/Service/TaskService.java +++ b/src/main/java/myapi/api/Service/TaskService.java @@ -2,7 +2,6 @@ package myapi.api.Service; import java.util.List; -import org.springframework.stereotype.Service; import myapi.api.Model.Task; diff --git a/src/main/java/myapi/api/Service/TaskServiceImpl.java b/src/main/java/myapi/api/Service/TaskServiceImpl.java index ffc7e22..3fb222a 100644 --- a/src/main/java/myapi/api/Service/TaskServiceImpl.java +++ b/src/main/java/myapi/api/Service/TaskServiceImpl.java @@ -1,7 +1,6 @@ package myapi.api.Service; import java.util.List; -import java.util.Objects; import myapi.api.Model.Task; import myapi.api.Repository.TaskRepository; import org.springframework.beans.factory.annotation.Autowired; @@ -13,16 +12,25 @@ public class TaskServiceImpl implements TaskService { @Autowired private TaskRepository taskRepository; + /** (non-Javadoc) + * @see myapi.api.Service.TaskService#getAllTasks() + */ @Override public List getAllTasks() { return taskRepository.findAll(); } + /** (non-Javadoc) + * @see myapi.api.Service.TaskService#addTask(myapi.api.Model.Task) + */ @Override public Task addTask(Task task) { return taskRepository.save(task); } + /** (non-Javadoc) + * @see myapi.api.Service.TaskService#updateTask(myapi.api.Model.Task) + */ @Override public Task updateTask(Task task) { Task dbTask = taskRepository.findById(task.getId_task()).get(); @@ -35,6 +43,9 @@ public class TaskServiceImpl implements TaskService { return taskRepository.save(dbTask); } + /** (non-Javadoc) + * @see myapi.api.Service.TaskService#deleteTask(int) + */ @Override public void deleteTask(int taskId) { taskRepository.deleteById(taskId);