(김기현) Todo 일기 작성하기 (Side-Project) 리뷰 부탁드립니다.

README.md

@@ -1,2 +1,72 @@
 # SELAB-TODO
 > basic todo with spring-mvc
+
+# 요구명세서
+> 일기 작성 서비스
+
+## 목차
+1. 소개
+   1. 목적
+2. 일반적인 기술 사항
+   1. 제품의 기능
+   2. 사용자 특성
+   3. 제약사항
+   4. 가정 및 의존성
+3. 상세기능 요구 사항
+   1. 기능적 요구 사항
+      1. 기본적인 CRUD
+         1. 등록
+         2. 조회
+         3. 수정
+         4. 삭제
+
+## 소개
+### 1.i 목적
+동건이형께 Todo 스터디를 완료했으므로 사이드 프로젝트를 진행하기 위하여 시작함
+## 일반적인 기술 사항
+### 2. i 제품의 기능
+앱은 아래와 같은 기능들을 주요 기능으로 갖는다
+* 단건 조회
+* 범위 조회
+* 전체 조회
+* 수정
+* 등록
+* 삭제
+* 전체 삭제
+### 2.ii 사용자 특정
+사용자는 일기를 생성할 수 있어야 한다. 생성은 Json 파일 형식으로 해야 한다
+
+
+사용자는 일기 조회를 할 수 있어야 한다. 단건 조회는 ID를 입력했을 때 가능하며, 범위 조회는
+월(Month)를 입력했을 때 가능해야 한다
+
+
+사용자는 일기 수정이 가능해야 한다. 수정하는 것은 ID로 수정할 수 있도록 한다.
+
+
+사용자는 일기 삭제가 가능해야 한다. 삭제는 ID를 통해 이루어지도록 한다.
+### 2.iii 제약사항
+* spring framework를 사용하여 구현한다
+* MySQL과 Jpa를 사용하여 데이터베이스와 연결한다
+* create-drop을 사용하기 때문에 데이터베이스에 데이터베이스 스키마를 만들지 않아도 된다
+
+## 상세기능 요구 사항
+### 3.i. 기능적 요구 사항
+### 3.i.a 기본적인 CRUD
+### 3.i.a.a 등록
+* request : id, 등록 날짜, 제목, 내용, 기분
+### 3.i.a.b 조회
+#### 단건 조회
+* request : id
+#### 범위 조회
+* request : Month
+* response : page
+#### 전체 조회
+* request : none
+* response : page
+### 3.i.a.c 수정
+* request : id
+### 3.i.a.d 삭제
+* request : none
+
+

build.gradle

@@ -6,7 +6,7 @@ plugins {
 
 group = 'com.selab'
 version = '0.0.1-SNAPSHOT'
-sourceCompatibility = '11'
+sourceCompatibility = "11"
 
 configurations {
     compileOnly {
@@ -29,8 +29,13 @@ dependencies {
     annotationProcessor 'org.springframework.boot:spring-boot-configuration-processor'
     annotationProcessor 'org.projectlombok:lombok'
     testImplementation 'org.springframework.boot:spring-boot-starter-test'
+
+    // swagger
+    implementation "io.springfox:springfox-boot-starter:3.0.0"
+
 }
 
 tasks.named('test') {
     useJUnitPlatform()
 }
+targetCompatibility = JavaVersion.VERSION_16

src/main/java/com/selab/todo/common/BaseEntity.java

@@ -0,0 +1,21 @@
+package com.selab.todo.common;
+
+import lombok.Getter;
+import org.springframework.data.annotation.CreatedDate;
+import org.springframework.data.annotation.LastModifiedDate;
+import org.springframework.data.jpa.domain.support.AuditingEntityListener;
+
+import javax.persistence.EntityListeners;
+import javax.persistence.MappedSuperclass;
+import java.time.LocalDateTime;
+
+@Getter
+@MappedSuperclass
+@EntityListeners(AuditingEntityListener.class)
+public abstract class BaseEntity {
+    @CreatedDate
+    private LocalDateTime createdAt;
+
+    @LastModifiedDate
+    private LocalDateTime modifiedAt;
+}

src/main/java/com/selab/todo/common/dto/PageDto.java

@@ -0,0 +1,28 @@
+package com.selab.todo.common.dto;
+
+import lombok.Data;
+import lombok.RequiredArgsConstructor;
+import org.springframework.data.domain.Page;
+import org.springframework.http.ResponseEntity;
+
+import java.util.List;
+
+@Data
+@RequiredArgsConstructor
+public class PageDto<T> {
+    private final List<T> data;
+    private final int page;
+    private final int size;
+    private final long totalElements;
+
+    public static <T> ResponseEntity<PageDto<T>> ok(Page<T> data) {
+        var response = new PageDto<T>(
+                data.getContent(),
+                data.getPageable().getPageNumber(),
+                data.getPageable().getPageSize(),
+                data.getTotalElements()
+        );
+
+        return ResponseEntity.ok(response);
+    }
+}

src/main/java/com/selab/todo/common/dto/ResponseDto.java

@@ -0,0 +1,30 @@
+package com.selab.todo.common.dto;
+
+import lombok.Data;
+import lombok.RequiredArgsConstructor;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+
+@Data
+@RequiredArgsConstructor
+public class ResponseDto<T> {
+    private final T data;
+
+    public static <T> ResponseEntity<ResponseDto<T>> ok(T data) {
+        var response = new ResponseDto<T>(data);
+        return ResponseEntity.ok(response);
+    }
+
+    public static <T> ResponseEntity<ResponseDto<T>> created(T data) {
+        var response = new ResponseDto<T>(data);
+        return ResponseEntity
+                .status(HttpStatus.CREATED)
+                .body(response);
+    }
+
+    public static ResponseEntity<Void> noContent() {
+        return ResponseEntity
+                .status(HttpStatus.NO_CONTENT)
+                .build();
+    }
+}

src/main/java/com/selab/todo/config/JpaConfig.java

@@ -0,0 +1,9 @@
+package com.selab.todo.config;
+
+import org.springframework.context.annotation.Configuration;
+import org.springframework.data.jpa.repository.config.EnableJpaAuditing;
+
+@Configuration
+@EnableJpaAuditing
+public class JpaConfig {
+}

src/main/java/com/selab/todo/config/SwaggerConfig.java

@@ -0,0 +1,39 @@
+package com.selab.todo.config;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import springfox.documentation.builders.ApiInfoBuilder;
+import springfox.documentation.builders.PathSelectors;
+import springfox.documentation.builders.RequestHandlerSelectors;
+import springfox.documentation.oas.annotations.EnableOpenApi;
+import springfox.documentation.service.ApiInfo;
+import springfox.documentation.spi.DocumentationType;
+import springfox.documentation.spring.web.plugins.Docket;
+
+import javax.servlet.http.HttpServletRequest;
+
+@Configuration
+@EnableOpenApi
+public class SwaggerConfig {
+    @Bean
+    public Docket restApi() {
+        return new Docket(DocumentationType.OAS_30)
+                .ignoredParameterTypes(
+                        HttpServletRequest.class
+                )
+                .useDefaultResponseMessages(false)
+                .apiInfo(apiInfo())
+                .select()
+                .apis(RequestHandlerSelectors.basePackage("com.selab.todo"))
+                .paths(PathSelectors.regex("/api/.*"))
+                .build();
+    }
+
+    private ApiInfo apiInfo() {
+        return new ApiInfoBuilder()
+                .title("Selab Todo api info")
+                .description("SE TODO API")
+                .version("1.0.0")
+                .build();
+    }
+}

src/main/java/com/selab/todo/config/WebConfig.java

@@ -0,0 +1,29 @@
+package com.selab.todo.config;
+
+import lombok.RequiredArgsConstructor;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.web.cors.CorsConfiguration;
+import org.springframework.web.cors.UrlBasedCorsConfigurationSource;
+import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
+
+// CORS --> 가장 많이 발생
+@Configuration
+@RequiredArgsConstructor
+public class WebConfig implements WebMvcConfigurer {
+    @Bean
+    public UrlBasedCorsConfigurationSource corsConfigurationSource() {
+        var corsConfig = new CorsConfiguration();
+
+        corsConfig.addAllowedOriginPattern(CorsConfiguration.ALL);
+        corsConfig.addAllowedHeader(CorsConfiguration.ALL);
+        corsConfig.addAllowedMethod(CorsConfiguration.ALL);
+
+        corsConfig.setAllowCredentials(true);
+        corsConfig.setMaxAge(3600L);
+
+        var corsConfigSource = new UrlBasedCorsConfigurationSource();
+        corsConfigSource.registerCorsConfiguration("/**", corsConfig);
+        return corsConfigSource;
+    }
+}

src/main/java/com/selab/todo/controller/TodoController.java

@@ -1,30 +1,83 @@
 package com.selab.todo.controller;
 
+import com.selab.todo.common.dto.PageDto;
+import com.selab.todo.common.dto.ResponseDto;
 import com.selab.todo.dto.request.TodoRegisterRequest;
-import com.selab.todo.dto.response.TodoResponse;
+import com.selab.todo.dto.request.TodoUpdateRequest;
 import com.selab.todo.service.TodoService;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import lombok.RequiredArgsConstructor;
+import org.springframework.data.domain.Pageable;
+import org.springframework.data.domain.Sort;
+import org.springframework.data.web.PageableDefault;
 import org.springframework.http.MediaType;
+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;
 import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.PutMapping;
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
+@Api(tags = {"TODO API"})
 @RestController
 @RequestMapping(value = "/api/v1/todos", produces = MediaType.APPLICATION_JSON_VALUE)
 @RequiredArgsConstructor
 public class TodoController {
     private final TodoService todoService;
 
-    @PostMapping(consumes = MediaType.APPLICATION_JSON_VALUE)
-    public TodoResponse register(@RequestBody TodoRegisterRequest request) {
-        return todoService.register(request);
+    @ApiOperation(value = "TODO 등록하기")
+    @PostMapping(consumes = MediaType.APPLICATION_JSON_VALUE, value = "/")
+    public ResponseEntity<?> register(@RequestBody TodoRegisterRequest request) {
+        var response = todoService.register(request);
+        return ResponseDto.created(response);
     }
 
+    @ApiOperation(value = "TODO 단건 조회하기")
     @GetMapping("/{id}")
-    public TodoResponse get(@PathVariable Long id) {
-        return todoService.get(id);
+    public ResponseEntity<?> get(@PathVariable Long id) {
+        var response = todoService.get(id);
+        return ResponseDto.ok(response);
+    }
+
+    @ApiOperation(value = "TODO 범위 조회")
+    @GetMapping("/month/{month}")
+    public ResponseEntity<?> getRange(
+            @PathVariable int month,
+            @PageableDefault Pageable pageable
+    ) {
+        var response = todoService.getRange(pageable,month);
+        return PageDto.ok(response);
+    }
+
+    @ApiOperation(value = "TODO 전체 조회하기")
+    @GetMapping
+    public ResponseEntity<?> getAll(
+            @PageableDefault(sort = "createdAt", direction = Sort.Direction.DESC) Pageable pageable
+    ) {
+        var response = todoService.getAll(pageable);
+        return PageDto.ok(response);
+    }
+
+    @ApiOperation(value = "TODO 수정하기")
+    @PutMapping("/{id}") // @PatchMapping
+    public ResponseEntity<?> update(
+            @PathVariable Long id,
+            @RequestBody TodoUpdateRequest request
+    ) {
+        var response = todoService.update(id, request);
+        return ResponseDto.ok(response);
+    }
+
+    @ApiOperation(value = "TODO 삭제하기")
+    @DeleteMapping("/{id}")
+    public ResponseEntity<Void> delete(
+            @PathVariable Long id
+    ) {
+        todoService.delete(id);
+        return ResponseDto.noContent();
     }
 }

src/main/java/com/selab/todo/dto/request/TodoRegisterRequest.java

@@ -6,4 +6,5 @@
 public class TodoRegisterRequest {
     private final String title;
     private final String content;
+    private final String feel;
 }

src/main/java/com/selab/todo/dto/request/TodoUpdateRequest.java

@@ -6,4 +6,5 @@
 public class TodoUpdateRequest {
     private final String title;
     private final String content;
+    private final String feel;
 }

src/main/java/com/selab/todo/dto/response/TodoResponse.java

@@ -1,10 +1,25 @@
 package com.selab.todo.dto.response;
 
+import com.selab.todo.entity.Todo;
 import lombok.Data;
 
+import java.time.LocalDateTime;
+
 @Data
 public class TodoResponse {
     private final Long id;
     private final String title;
     private final String content;
+    private final LocalDateTime localDateTime;
+    private final String feel;
+
+    public static TodoResponse from(Todo todo) {
+        return new TodoResponse(
+                todo.getId(),
+                todo.getTitle(),
+                todo.getContent(),
+                todo.getCreatedAt(),
+                todo.getFeel()
+        );
+    }
 }