[4기 박현지, 최지연] 컨트롤러 구현 및 테스트(RestDocs 적용), 엔티티 VO 분리

build.gradle

@@ -13,6 +13,7 @@ java {
 }
 
 configurations {
+    asciidoctorExt
     compileOnly {
         extendsFrom annotationProcessor
     }
@@ -33,9 +34,9 @@ dependencies {
     runtimeOnly 'com.h2database:h2'
     annotationProcessor 'org.projectlombok:lombok'
     testImplementation 'org.springframework.boot:spring-boot-starter-test'
+    asciidoctorExt 'org.springframework.restdocs:spring-restdocs-asciidoctor'
     testImplementation 'org.springframework.restdocs:spring-restdocs-mockmvc'
     implementation 'org.springframework.boot:spring-boot-starter-validation:3.0.4'
-    implementation 'org.springframework.boot:spring-boot-starter-security'
 }
 
 tasks.named('test') {
@@ -45,5 +46,6 @@ tasks.named('test') {
 
 tasks.named('asciidoctor') {
     inputs.dir snippetsDir
+    configurations 'asciidoctorExt'
     dependsOn test
 }

src/docs/asciidoc/index.adoc

@@ -0,0 +1,76 @@
+:hardbreaks:
+ifndef::snippets[]
+:snippets: ../../build/generated-snippets
+endif::[]
+
+:icons: font
+:source-highlighter: highlightjs
+:toc: left
+:toclevels: 2
+:sectlinks:
+:sectnums:
+:docinfo: shared-head
+
+== 게시글
+
+=== 게시글 생성
+
+==== [POST] /api/v1/posts
+
+.Request
+include::{snippets}/post-save/http-request.adoc[]
+
+.Request Fields
+include::{snippets}/post-save/request-fields.adoc[]
+
+.Response
+include::{snippets}/post-save/http-response.adoc[]
+
+=== 게시글 조회
+
+==== [GET] /api/v1/posts/{id}
+
+.Request
+include::{snippets}/post-get-one/http-request.adoc[]
+
+.Response
+include::{snippets}/post-get-one/http-response.adoc[]
+
+.Response Fields
+include::{snippets}/post-get-one/response-fields.adoc[]
+
+=== 게시글 페이지 조회
+
+==== [GET] /api/v1/posts?page={page}&size={size}&sort={sort}
+
+.Request
+include::{snippets}/post-get-by-page/http-request.adoc[]
+
+.Response
+include::{snippets}/post-get-by-page/http-response.adoc[]
+
+.Response Fields
+include::{snippets}/post-get-by-page/response-fields.adoc[]
+
+=== 게시글 수정
+
+==== [PATCH] /api/v1/posts/{id}
+
+.Request
+include::{snippets}/post-update/http-request.adoc[]
+
+.Request Fields
+include::{snippets}/post-update/request-fields.adoc[]
+
+.Response
+include::{snippets}/post-update/http-response.adoc[]
+
+=== 게시글 삭제
+
+==== [DELETE] /api/v1/posts/{id}
+
+.Request
+include::{snippets}/post-delete/http-request.adoc[]
+
+.Response
+include::{snippets}/post-delete/http-response.adoc[]

src/main/java/org/prgms/boardservice/domain/post/Content.java

@@ -0,0 +1,34 @@
+package org.prgms.boardservice.domain.post;
+
+import jakarta.persistence.Column;
+import jakarta.persistence.Embeddable;
+import jakarta.persistence.Lob;
+import lombok.AccessLevel;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+import static org.prgms.boardservice.util.ErrorMessage.INVALID_POST_CONTENT;
+import static org.springframework.util.StringUtils.hasText;
+
+@Embeddable
+@EqualsAndHashCode
+@NoArgsConstructor(access = AccessLevel.PROTECTED)
+@Getter
+public class Content {
+
+    @Lob
+    @Column(nullable = false)
+    private String content;
+
+    public Content(String content) {
+        validateContentLength(content);
+        this.content = content;
+    }
+
+    private void validateContentLength(String value) {
+        if (!hasText(value) || value.length() > 500) {
+            throw new IllegalArgumentException(INVALID_POST_CONTENT.getMessage());
+        }
+    }
+}

src/main/java/org/prgms/boardservice/domain/post/Post.java

@@ -1,59 +1,41 @@
 package org.prgms.boardservice.domain.post;
 
 import jakarta.persistence.*;
-import jakarta.validation.constraints.NotBlank;
-import lombok.AccessLevel;
-import lombok.Getter;
-import lombok.NoArgsConstructor;
+import jakarta.validation.constraints.NotNull;
+import lombok.*;
+import org.hibernate.annotations.DynamicUpdate;
 import org.prgms.boardservice.domain.BaseTime;
 
-import static org.prgms.boardservice.util.ErrorMessage.INVALID_POST_CONTENT;
-import static org.prgms.boardservice.util.ErrorMessage.INVALID_POST_TITLE;
-
+@Builder
 @Getter
 @Entity
 @NoArgsConstructor(access = AccessLevel.PROTECTED)
+@AllArgsConstructor
+@DynamicUpdate
+@EqualsAndHashCode(of = "id", callSuper = false)
 public class Post extends BaseTime {
 
     @Id
     @GeneratedValue(strategy = GenerationType.IDENTITY)
     private Long id;
 
-    @Column(length = 20)
-    @NotBlank
-    private String title;
+    @Embedded
+    private Title title;
 
-    @Lob
-    @NotBlank
-    private String content;
+    @Embedded
+    private Content content;
 
+    @NotNull
     private Long userId;
 
-    public Post(String title, String content) {
-        validateTitleLength(title);
-        validateContentLength(content);
-
+    public Post(Title title, Content content, Long userId) {
         this.title = title;
         this.content = content;
+        this.userId = userId;
     }
 
-    public void update(String title, String content) {
-        validateTitleLength(title);
-        validateContentLength(content);
-
+    public void update(Title title, Content content) {
         this.title = title;
         this.content = content;
     }
-
-    private void validateTitleLength(String title) {
-        if (!hasText(title) || title.length() > 20) {
-            throw new IllegalArgumentException(INVALID_POST_TITLE.getMessage());
-        }
-    }
-
-    private void validateContentLength(String content) {
-        if (!hasText(content) || content.length() > 500) {
-            throw new IllegalArgumentException(INVALID_POST_CONTENT.getMessage());
-        }
-    }
 }

src/main/java/org/prgms/boardservice/domain/post/PostController.java

@@ -0,0 +1,71 @@
+package org.prgms.boardservice.domain.post;
+
+import org.prgms.boardservice.domain.post.dto.PageResponse;
+import org.prgms.boardservice.domain.post.dto.PostCreateRequest;
+import org.prgms.boardservice.domain.post.dto.PostResponse;
+import org.prgms.boardservice.domain.post.dto.PostUpdateRequest;
+import org.prgms.boardservice.domain.post.vo.PostUpdate;
+import org.springframework.data.domain.Page;
+import org.springframework.data.domain.Pageable;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.*;
+
+import java.net.URI;
+import java.util.NoSuchElementException;
+
+@RestController
+@RequestMapping("/api/v1/posts")
+public class PostController {
+
+    private final PostService postService;
+
+    public PostController(PostService postService) {
+        this.postService = postService;
+    }
+
+    @ExceptionHandler(NoSuchElementException.class)
+    private ResponseEntity<String> noSuchElementExceptionHandle(NoSuchElementException exception) {
+        return ResponseEntity.badRequest()
+                .body(exception.getMessage());
+    }
+
+    @PostMapping
+    public ResponseEntity<Void> create(@RequestBody PostCreateRequest postCreateRequest) {
+        Long postId = postService.create(postCreateRequest.toEntity());
+
+        return ResponseEntity.created(URI.create("/api/v1/posts/" + postId))
+                .build();
+    }
+
+    @GetMapping("/{id}")
+    public ResponseEntity<PostResponse> getOne(@PathVariable Long id) throws NoSuchElementException {
+        PostResponse postResponse = new PostResponse(postService.getById(id));
+
+        return ResponseEntity.ok(postResponse);
+    }
+
+    @GetMapping
+    public ResponseEntity<PageResponse<PostResponse>> getPage(Pageable pageable) throws NoSuchElementException {
+        Page<Post> page = postService.getByPage(pageable);
+        Page<PostResponse> postResponseDtoPage = page.map(PostResponse::new);
+
+        return ResponseEntity.ok(new PageResponse<>(postResponseDtoPage));
+    }
+
+    @PatchMapping("/{id}")
+    public ResponseEntity<Void> update(@RequestBody PostUpdateRequest postUpdateRequest, @PathVariable Long id) {
+        Long postId = postService.update(new PostUpdate(id, postUpdateRequest.title(), postUpdateRequest.content()));
+
+        return ResponseEntity.noContent()
+                .location(URI.create("/api/v1/posts/" + postId))
+                .build();
+    }
+
+    @DeleteMapping("/{id}")
+    public ResponseEntity<Void> delete(@PathVariable Long id) {
+        postService.deleteById(id);
+
+        return ResponseEntity.noContent()
+                .build();
+    }
+}

src/main/java/org/prgms/boardservice/domain/post/PostService.java

@@ -1,6 +1,6 @@
 package org.prgms.boardservice.domain.post;
 
-import org.prgms.boardservice.domain.post.vo.PostUpdateVo;
+import org.prgms.boardservice.domain.post.vo.PostUpdate;
 import org.springframework.data.domain.Page;
 import org.springframework.data.domain.Pageable;
 import org.springframework.stereotype.Service;
@@ -24,11 +24,11 @@ public Long create(Post post) {
         return postRepository.save(post).getId();
     }
 
-    public Long update(PostUpdateVo postUpdateVo) {
-        Post findPost = postRepository.findById(postUpdateVo.id())
+    public Long update(PostUpdate postUpdate) {
+        Post findPost = postRepository.findById(postUpdate.id())
                 .orElseThrow(() -> new NoSuchElementException(NOT_FOUND_POST.getMessage()));
 
-        findPost.update(postUpdateVo.title(), postUpdateVo.content());
+        findPost.update(new Title(postUpdate.title()), new Content(postUpdate.content()));
 
         return postRepository.save(findPost).getId();
     }
@@ -45,6 +45,7 @@ public Page<Post> getByPage(Pageable pageable) {
     }
 
     public void deleteById(Long id) {
+        postRepository.findById(id).orElseThrow(() -> new NoSuchElementException(NOT_FOUND_POST.getMessage()));
         postRepository.deleteById(id);
     }
 

src/main/java/org/prgms/boardservice/domain/post/Title.java

@@ -0,0 +1,32 @@
+package org.prgms.boardservice.domain.post;
+
+import jakarta.persistence.Column;
+import jakarta.persistence.Embeddable;
+import lombok.AccessLevel;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+import static org.prgms.boardservice.util.ErrorMessage.INVALID_POST_TITLE;
+import static org.springframework.util.StringUtils.hasText;
+
+@Embeddable
+@EqualsAndHashCode
+@NoArgsConstructor(access = AccessLevel.PROTECTED)
+@Getter
+public class Title {
+
+    @Column(length = 20, nullable = false)
+    private String title;
+
+    public Title(String title) {
+        validateTitleLength(title);
+        this.title = title;
+    }
+
+    private void validateTitleLength(String value) {
+        if (!hasText(value) || value.length() > 20) {
+            throw new IllegalArgumentException(INVALID_POST_TITLE.getMessage());
+        }
+    }
+}

src/main/java/org/prgms/boardservice/domain/post/dto/PageResponse.java

@@ -0,0 +1,36 @@
+package org.prgms.boardservice.domain.post.dto;
+
+import org.springframework.data.domain.Page;
+
+import java.util.List;
+
+public record PageResponse<E>(
+        List<E> data,
+        PageableResponse<E> pageable
+) {
+    public PageResponse(Page<E> page) {
+        this(page.getContent(), new PageableResponse<>(page));
+    }
+
+    private record PageableResponse<E>(
+            boolean first,
+            boolean last,
+            int number,
+            int size,
+            String sort,
+            int totalPages,
+            long totalElements
+    ) {
+        private PageableResponse(Page<E> page) {
+            this(
+                    page.isFirst(),
+                    page.isLast(),
+                    page.getNumber(),
+                    page.getSize(),
+                    page.getSort().toString(),
+                    page.getTotalPages(),
+                    page.getTotalElements()
+            );
+        }
+    }
+}