[F팀 장주리] 백엔드 API 과제 제출

build.gradle

@@ -27,6 +27,8 @@ dependencies {
 	implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
 	//implementation 'org.springframework.boot:spring-boot-starter-security'
 	implementation 'org.springframework.boot:spring-boot-starter-web'
+	//swagger library
+	implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.0.2'
 	compileOnly 'org.projectlombok:lombok'
 	runtimeOnly 'com.h2database:h2'
 	annotationProcessor 'org.projectlombok:lombok'

src/main/java/com/example/techeer_partners_api_session/config/SwaggerConfig.java

@@ -0,0 +1,27 @@
+package com.example.techeer_partners_api_session.config;
+
+import io.swagger.v3.oas.models.Components;
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.info.Info;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.web.servlet.config.annotation.EnableWebMvc;
+
+@Configuration
+@EnableWebMvc
+public class SwaggerConfig {
+
+    @Bean
+    public OpenAPI openAPI() {
+        return new OpenAPI()
+                .components(new Components())
+                .info(apiInfo());
+    }
+
+    private Info apiInfo() {
+        return new Info()
+                .title("API Test") // API의 제목
+                .description("Todo list Sawgger UI") // API에 대한 설명
+                .version("3.0"); // API의 버전
+    }
+}

src/main/java/com/example/techeer_partners_api_session/controller/TaskController.java

@@ -0,0 +1,107 @@
+package com.example.techeer_partners_api_session.controller;
+
+import com.example.techeer_partners_api_session.dto.TaskRequestDto;
+import com.example.techeer_partners_api_session.dto.TaskResponseDto;
+import com.example.techeer_partners_api_session.entity.Task;
+import com.example.techeer_partners_api_session.repository.TaskRepository;
+import com.example.techeer_partners_api_session.service.TaskService;
+import io.swagger.v3.oas.annotations.Operation;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.*;
+
+import java.util.*;
+import java.util.stream.Collectors;
+
+@RestController
+@RequestMapping("/tasks")
+public class TaskController {
+    private final TaskService taskService;
+    private final TaskRepository taskRepository;
+
+    public TaskController(TaskService taskService, TaskRepository taskRepository) {
+        this.taskService = taskService;
+        this.taskRepository = taskRepository;
+    }
+
+    private <T> ResponseEntity<Map<String, Object>> createResponse(String status, String message, T data) {
+        Map<String, Object> response = new LinkedHashMap<>();
+        response.put("status", status);
+        response.put("message", message);
+        if(data != null){
+            response.put("data", data);
+        }
+        return ResponseEntity.ok(response);
+    }
+
+    //할 일 등록
+    @Operation(summary = "할 일 등록")
+    @PostMapping
+    public ResponseEntity<Map<String, Object>> createTask(@RequestBody TaskRequestDto dto) {
+        if (dto.getTitle() == null || dto.getTitle().isBlank()) {
+            return createResponse("fail", "title은 필수 입력입니다.", null);
+        }
+
+        taskService.createTask(dto);
+        return createResponse("success", "할 일이 생성 되었습니다.", null);
+    }
+
+    // 전체 조회
+    @Operation(summary = "할 일 전체 조회")
+    @GetMapping
+    public ResponseEntity<Map<String, Object>> getTasks() {
+        List<Task> tasks = taskService.getAllTask();
+        List<TaskResponseDto> taskResponseDtos = tasks.stream()
+                .map(task -> new TaskResponseDto(task.getId(), task.getTitle(), task.isDone()))
+                .collect(Collectors.toList());
+        return createResponse("success", "전체 할 일이 조회되었습니다.", taskResponseDtos);
+    }
+
+    // 완료된 일만 조회
+    @Operation(summary = "완료된 일 조회")
+    @GetMapping("/completed")
+    public ResponseEntity<Map<String, Object>> getCompletedTasks() {
+        List<Task> tasks = taskService.getCompletedTask();
+        List<TaskResponseDto> taskResponseDtos = tasks.stream()
+                .map(task -> new TaskResponseDto(task.getId(), task.getTitle(), task.isDone()))
+                .collect(Collectors.toList());
+        return createResponse("success", "완료된 일이 조회되었습니다.", taskResponseDtos);
+    }
+
+    // 미완료된 일만 조회
+    @Operation(summary = "미완료된 일 조회")
+    @GetMapping("/inCompleted")
+    public ResponseEntity<Map<String, Object>> getInCompletedTasks() {
+        List<Task> tasks = taskService.getInCompletedTask();
+        List<TaskResponseDto> taskResponseDtos = tasks.stream()
+                .map(task -> new TaskResponseDto(task.getId(), task.getTitle(), task.isDone()))
+                .collect(Collectors.toList());
+        return createResponse("success", "미완료된 일이 조회되었습니다.", taskResponseDtos);
+    }
+
+
+    //할 일 수정
+    @Operation(summary = "할 일 수정")
+    @PutMapping("/{id}")
+    public ResponseEntity<Map<String, Object>> updateTask(@PathVariable Long id, @RequestBody TaskRequestDto dto){
+        Optional<Task> task = taskRepository.findById(id);
+        if (task.isPresent()) {
+            taskService.updateTask(id, dto); // 작업이 성공적으로 이루어지면 응답
+            return createResponse("success", "할 일이 수정 되었습니다.", null);
+        } else {
+            return createResponse("fail", "해당 할 일이 존재하지 않습니다.", null);
+        }
+    }
+
+    //할 일 삭제
+    @Operation(summary = "할 일 삭제")
+    @DeleteMapping("/{id}")
+    public ResponseEntity<Map<String, Object>> deleteTask(@PathVariable Long id){
+        Optional<Task> task = taskRepository.findById(id);
+        if (task.isPresent()) {
+            taskService.deleteTask(id);
+            return createResponse("success", "할 일이 삭제 되었습니다.", null);
+        } else {
+            return createResponse("fail", "해당 할 일이 존재하지 않습니다.", null);
+        }
+    }
+}

src/main/java/com/example/techeer_partners_api_session/dto/TaskRequestDto.java

@@ -0,0 +1,11 @@
+package com.example.techeer_partners_api_session.dto;
+
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+
+@Getter
+@AllArgsConstructor
+public class TaskRequestDto {
+    private final String title;
+    private final boolean isDone;
+}

src/main/java/com/example/techeer_partners_api_session/dto/TaskResponseDto.java

@@ -0,0 +1,12 @@
+package com.example.techeer_partners_api_session.dto;
+
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+
+@Getter
+@AllArgsConstructor
+public class TaskResponseDto {
+    private Long id;
+    private String title;
+    private boolean isDone;
+}

src/main/java/com/example/techeer_partners_api_session/entity/Task.java

@@ -0,0 +1,26 @@
+package com.example.techeer_partners_api_session.entity;
+
+import jakarta.persistence.*;
+import lombok.Getter;
+import lombok.Setter;
+
+@Entity
+@Getter
+@Setter
+public class Task {
+    @Id
+    @GeneratedValue(strategy = GenerationType.IDENTITY)
+    private Long id;
+
+    @Column(nullable = false)
+    private String title;
+
+    private boolean isDone = false;
+
+    public Task(){}
+
+    public Task(String title) {
+        this.title = title;
+    }
+
+}

src/main/java/com/example/techeer_partners_api_session/repository/TaskRepository.java

@@ -0,0 +1,12 @@
+package com.example.techeer_partners_api_session.repository;
+
+import com.example.techeer_partners_api_session.entity.Task;
+import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.stereotype.Repository;
+
+import java.util.List;
+
+@Repository
+public interface TaskRepository extends JpaRepository<Task, Long> {
+    List<Task> findByIsDone(boolean isDone); //완료 여부 필터링
+}

src/main/java/com/example/techeer_partners_api_session/service/TaskService.java

@@ -0,0 +1,61 @@
+package com.example.techeer_partners_api_session.service;
+
+import com.example.techeer_partners_api_session.dto.TaskRequestDto;
+import com.example.techeer_partners_api_session.entity.Task;
+import com.example.techeer_partners_api_session.repository.TaskRepository;
+import org.springframework.stereotype.Service;
+
+import java.util.List;
+import java.util.Optional;
+
+@Service
+public class TaskService {
+    private final TaskRepository taskRepository;
+
+    public TaskService(TaskRepository taskRepository) {
+        this.taskRepository = taskRepository;
+    }
+
+    //할 일 생성
+    public void createTask(TaskRequestDto dto){
+        Task task = new Task(dto.getTitle());
+        taskRepository.save(task);
+    }
+
+    //할 일 전체 목록 조회
+    public List<Task> getAllTask(){
+        return taskRepository.findAll();
+    }
+
+    //완료된 일 조회
+    public List<Task> getCompletedTask(){
+        return taskRepository.findByIsDone(true);
+    }
+
+    //미완료된 일 조회
+    public List<Task> getInCompletedTask(){
+        return taskRepository.findByIsDone(false);
+    }
+
+    //할 일 수정
+    public void updateTask(Long id, TaskRequestDto dto){
+        Optional<Task> task = taskRepository.findById(id);
+
+        if(task.isPresent()){ //task에 값이 존재하는지 확인
+            Task existingTask = task.get(); //존재하면 해당 task get
+
+            //할 일 수정
+            if(dto.getTitle() != null){
+                existingTask.setTitle(dto.getTitle());
+            }
+            existingTask.setDone(dto.isDone());
+            taskRepository.save(existingTask);
+        }
+    }
+
+    //할 일 삭제
+    public void deleteTask(Long id){
+        taskRepository.deleteById(id);
+    }
+}
+