[최종점검] 스터디 과제 제출

howoldareu_clone/build.gradle

@@ -2,34 +2,50 @@ plugins {
 	id 'java'
 	id 'org.springframework.boot' version '3.2.0'
 	id 'io.spring.dependency-management' version '1.1.4'
+	id 'org.asciidoctor.convert' version '1.5.8'
 }
 
 group = 'com.sopt'
 version = '0.0.1-SNAPSHOT'
-
 java {
 	sourceCompatibility = '17'
 }
-
 configurations {
 	compileOnly {
 		extendsFrom annotationProcessor
 	}
 }
 
+ext {
+	set('snippetsDir', file("build/generated-snippets"))
+}
+
 repositories {
 	mavenCentral()
 }
-
 dependencies {
 	implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
 	implementation 'org.springframework.boot:spring-boot-starter-web'
 	compileOnly 'org.projectlombok:lombok'
 	runtimeOnly 'com.mysql:mysql-connector-j'
+
+	// h2
+	runtimeOnly 'com.h2database:h2'
+
 	annotationProcessor 'org.projectlombok:lombok'
 	testImplementation 'org.springframework.boot:spring-boot-starter-test'
+
+	// Rest Docs
+	testImplementation 'org.springframework.restdocs:spring-restdocs-mockmvc'
+	testImplementation 'org.springframework.restdocs:spring-restdocs-asciidoctor'
 }
 
 tasks.named('test') {
+	outputs.dir snippetsDir
 	useJUnitPlatform()
 }
+
+tasks.named('asciidoctor') {
+	inputs.dir snippetsDir
+	dependsOn test
+}

howoldareu_clone/src/docs/asciidoc/api/member.adoc

@@ -0,0 +1,9 @@
+[[save-member]]
+== Save Member
+
+=== HTTP Request
+include::{snippets}/save-member/http-request.adoc[]
+
+=== HTTP Response
+include::{snippets}/save-member/http-response.adoc[]
+include::{snippets}/save-member/response-fields.adoc[]

howoldareu_clone/src/docs/asciidoc/api/question.adoc

@@ -0,0 +1,9 @@
+[[get-question]]
+== GET Question
+
+=== HTTP Request
+include::{snippets}/get-questions/http-request.adoc[]
+
+=== HTTP Response
+include::{snippets}/get-questions/http-response.adoc[]
+include::{snippets}/get-questions/response-fields.adoc[]

howoldareu_clone/src/docs/asciidoc/api/result.adoc

@@ -0,0 +1,19 @@
+[[save-result]]
+== SAVE RESULT
+
+=== HTTP Request
+include::{snippets}/save-result/http-request.adoc[]
+
+=== HTTP Response
+include::{snippets}/save-result/http-response.adoc[]
+include::{snippets}/save-result/response-fields.adoc[]
+
+[[get-all-results]]
+== GET ALL RESULTS
+
+=== HTTP Request
+include::{snippets}/get-all-results/http-request.adoc[]
+
+=== HTTP Response
+include::{snippets}/get-all-results/http-response.adoc[]
+include::{snippets}/get-all-results/response-fields.adoc[]

howoldareu_clone/src/docs/asciidoc/index.adoc

@@ -0,0 +1,23 @@
+ifndef::snippets[]
+:snippets: "../../build/generated-snippets"
+endif::[]
+
+= HOWOLDAREYOU REST API 문서
+:doctype: book
+:icons: font
+:source-highlighter: highlightjs
+:toc: left
+:toclevels: 2
+:seclinks:
+
+[[Member-API]]
+== Member API
+include::api/member.adoc[]
+
+[[Question-API]]
+== Question API
+include::api/question.adoc[]
+
+[[Result-API]]
+== Result API
+include::api/result.adoc[]

howoldareu_clone/src/main/java/com/sopt/Server/ServerApplication.java

@@ -5,7 +5,6 @@
 import org.springframework.data.jpa.repository.config.EnableJpaAuditing;
 
 @SpringBootApplication
-@EnableJpaAuditing
 public class ServerApplication {
 
 	public static void main(String[] args) {

howoldareu_clone/src/main/java/com/sopt/Server/common/JpaAuditingConfiguration.java

@@ -0,0 +1,9 @@
+package com.sopt.Server.common;
+
+import org.springframework.data.jpa.repository.config.EnableJpaAuditing;
+import org.springframework.stereotype.Component;
+
+@Component
+@EnableJpaAuditing
+public class JpaAuditingConfiguration {
+}

howoldareu_clone/src/main/java/com/sopt/Server/controller/MemberController.java

@@ -5,20 +5,25 @@
 import com.sopt.Server.controller.response.MemberGetResponse;
 import com.sopt.Server.service.MemberService;
 import lombok.RequiredArgsConstructor;
+import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RestController;
 
+import java.net.URI;
+
+import static com.sopt.Server.exception.Success.CREATE_MEMBER_SUCCESS;
+
 @RestController
 @RequiredArgsConstructor
 public class MemberController {
-
+    
     private final MemberService memberService;
 
     @PostMapping("/member")
-    public ApiResponse<MemberGetResponse> saveMember(@RequestBody MemberPostRequest request) {
-
-        ApiResponse<MemberGetResponse> response = memberService.saveMember(request.nickName(), request.age());
-        return response;
+    public ResponseEntity<ApiResponse<MemberGetResponse>> saveMember(@RequestBody MemberPostRequest request) {
+        MemberGetResponse response = memberService.saveMember(request);
+        URI uri = URI.create("/member"+response.memberId());
+        return ResponseEntity.created(uri).body(ApiResponse.success(CREATE_MEMBER_SUCCESS, response));
     }
 }

howoldareu_clone/src/main/java/com/sopt/Server/controller/QuestionController.java

@@ -1,7 +1,7 @@
 package com.sopt.Server.controller;
 
 import com.sopt.Server.common.ApiResponse;
-import com.sopt.Server.controller.response.GetQuestionResponseDTO;
+import com.sopt.Server.controller.response.GetQuestionResponse;
 import com.sopt.Server.exception.Success;
 import com.sopt.Server.service.QuestionService;
 import lombok.RequiredArgsConstructor;
@@ -18,8 +18,8 @@ public class QuestionController {
     private final QuestionService questionService;
 
     @GetMapping("")
-    public ApiResponse<List<GetQuestionResponseDTO>> getQuestionResponseDTOList() {
-        return ApiResponse.success(Success.GET_QUESTION_LIST_SUCCESS,questionService.getQuestionResponseDTOList());
+    public ApiResponse<List<GetQuestionResponse>> getQuestionResponseList() {
+        return ApiResponse.success(Success.GET_QUESTION_LIST_SUCCESS,questionService.getQuestionResponseList());
     }
 
 }

howoldareu_clone/src/main/java/com/sopt/Server/controller/ResultController.java

@@ -1,14 +1,16 @@
 package com.sopt.Server.controller;
 
 import com.sopt.Server.common.ApiResponse;
-import com.sopt.Server.controller.request.AnswerListRequestDTO;
-import com.sopt.Server.controller.response.AllResultsResponseDTO;
-import com.sopt.Server.controller.response.ResultResponseDTO;
+import com.sopt.Server.controller.request.AnswerListRequest;
+import com.sopt.Server.controller.response.AllResultsResponse;
+import com.sopt.Server.controller.response.ResultResponse;
 import com.sopt.Server.exception.Success;
 import com.sopt.Server.service.ResultService;
 import lombok.RequiredArgsConstructor;
+import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.*;
 
+import java.net.URI;
 import java.util.List;
 
 @RestController
@@ -18,12 +20,14 @@ public class ResultController {
     private final ResultService resultService;
 
     @PostMapping("")
-    public ApiResponse<ResultResponseDTO> saveResult(@RequestBody AnswerListRequestDTO answerListRequestDTO){
-        return ApiResponse.success(Success.CREATE_RESULT_SUCCESS,resultService.saveResult(answerListRequestDTO));
+    public ResponseEntity<ApiResponse<ResultResponse>> saveResult(@RequestBody AnswerListRequest answerListRequestDTO){
+        ResultResponse response = resultService.saveResult(answerListRequestDTO);
+        URI uri = URI.create("/result");
+        return ResponseEntity.created(uri).body(ApiResponse.success(Success.CREATE_RESULT_SUCCESS,response));
     }
 
     @GetMapping("/{memberId}")
-    public ApiResponse<List<AllResultsResponseDTO>> getAllResults(@PathVariable Long memberId) {
+    public ApiResponse<List<AllResultsResponse>> getAllResults(@PathVariable Long memberId) {
         return ApiResponse.success(Success.GET_USER_LIST_SUCCESS, resultService.getAllResults(memberId));
     }
 

howoldareu_clone/src/main/java/com/sopt/Server/controller/request/AnswerListRequest.java

@@ -0,0 +1,6 @@
+package com.sopt.Server.controller.request;
+
+import java.util.List;
+
+public record AnswerListRequest(String nickname, List<AnswerRequest> results) {
+}

howoldareu_clone/src/main/java/com/sopt/Server/controller/request/AnswerRequest.java

@@ -0,0 +1,4 @@
+package com.sopt.Server.controller.request;
+
+public record AnswerRequest(Long questionId, boolean answerType) {
+}

howoldareu_clone/src/main/java/com/sopt/Server/controller/response/AllResultsResponse.java

@@ -0,0 +1,11 @@
+package com.sopt.Server.controller.response;
+
+import com.sopt.Server.domain.Result;
+
+import java.util.List;
+
+public record AllResultsResponse(Long id, int resultAge, String title, String content, String testedDate, String imgUrl1, String imgUrl2) {
+    public static AllResultsResponse of(Result result, String title, String content, String testedDate, String imgUrl1, String imgUrl2) {
+        return new AllResultsResponse(result.getId(), result.getResultAge(), title, content, testedDate, imgUrl1, imgUrl2);
+    }
+}

howoldareu_clone/src/main/java/com/sopt/Server/controller/response/GetQuestionResponse.java

@@ -0,0 +1,7 @@
+package com.sopt.Server.controller.response;
+
+public record GetQuestionResponse(Long questionId, String questionContent) {
+    static public GetQuestionResponse of(Long questionId, String questionContent) {
+        return new GetQuestionResponse(questionId, questionContent);
+    }
+}

howoldareu_clone/src/main/java/com/sopt/Server/controller/response/ResultResponse.java

@@ -0,0 +1,7 @@
+package com.sopt.Server.controller.response;
+
+public record ResultResponse(String nickname, int resultAge, String title, String content, String imgUrl1, String imgUrl2) {
+    public static ResultResponse of(String nickname, int resultAge, String title, String content, String imgUrl1, String imgUrl2) {
+        return new ResultResponse(nickname, resultAge, title, content, imgUrl1, imgUrl2);
+    }
+}

howoldareu_clone/src/main/java/com/sopt/Server/domain/Answer.java

@@ -2,6 +2,7 @@
 
 import jakarta.persistence.*;
 import lombok.AccessLevel;
+import lombok.Builder;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 
@@ -14,11 +15,17 @@ public class Answer {
     @Id @GeneratedValue(strategy = GenerationType.IDENTITY)
     private Long answerId;
 
-    @ManyToOne
+    @ManyToOne(fetch = FetchType.LAZY)
     private Question question;
 
     private boolean answerType;
 
     private int answerScore;
 
+    @Builder
+    public Answer(Question question, boolean answerType, int answerScore) {
+        this.question = question;
+        this.answerType = answerType;
+        this.answerScore = answerScore;
+    }
 }

howoldareu_clone/src/main/java/com/sopt/Server/domain/Question.java

@@ -1,13 +1,23 @@
 package com.sopt.Server.domain;
 
 import jakarta.persistence.*;
+import lombok.AccessLevel;
+import lombok.Builder;
 import lombok.Getter;
+import lombok.NoArgsConstructor;
 
 @Entity
 @Getter
 @Table(name = "QUESTIONS")
+@NoArgsConstructor(access = AccessLevel.PROTECTED)
 public class Question {
     @Id @GeneratedValue(strategy = GenerationType.IDENTITY)
     private Long questionId;
     private String questionContent;
+
+    @Builder
+    public Question(Long questionId, String questionContent) {
+        this.questionId = questionId;
+        this.questionContent = questionContent;
+    }
 }

howoldareu_clone/src/main/java/com/sopt/Server/domain/Result.java

@@ -34,4 +34,8 @@ public Result(Long id, Member member, int resultAge, LocalDateTime testedDate) {
         this.resultAge = resultAge;
         this.testedDate = testedDate;
     }
+
+    public String getTestedDateToString(){
+        return testedDate.getMonthValue() + "월 " + testedDate.getDayOfMonth() + "일";
+    }
 }

howoldareu_clone/src/main/java/com/sopt/Server/common/AgeEnum.java → howoldareu_clone/src/main/java/com/sopt/Server/domain/enums/AgeEnum.java

@@ -1,4 +1,4 @@
-package com.sopt.Server.common;
+package com.sopt.Server.domain.enums;
 
 import lombok.AccessLevel;
 import lombok.AllArgsConstructor;
@@ -18,5 +18,18 @@ public enum AgeEnum {
     private final String imageUrl1;
     private final String imageUrl2;
 
+    public static AgeEnum getAgeEnum(int age){
+        if(age < 20)
+            return AgeEnum.TEENAGER;
+        else if(age < 30)
+            return AgeEnum.TWENTIES;
+        else if(age < 40)
+            return AgeEnum.THIRTIES;
+        else if(age < 50)
+            return AgeEnum.FORTIES;
+        else
+            return AgeEnum.FIFTIES;
+    }
+
 }