Merge pull request #104 from GGHDMS/feature/70-swagger-ui

[고도화] Swagger UI 로 API 문서화하기
GGHDMS · May 27, 2023 · c1ac877 · c1ac877
2 parents 4b89dc1 + a64bf6c
commit c1ac877
Show file tree

Hide file tree

Showing 5 changed files with 57 additions and 0 deletions.
diff --git a/.idea/compiler.xml b/.idea/compiler.xml
diff --git a/.idea/dataSources.xml b/.idea/dataSources.xml
diff --git a/.idea/sqldialects.xml b/.idea/sqldialects.xml
diff --git a/project-board/build.gradle b/project-board/build.gradle
@@ -37,6 +37,10 @@ dependencies {
     implementation 'org.springframework.boot:spring-boot-starter-security'
     implementation 'org.thymeleaf.extras:thymeleaf-extras-springsecurity5'
     implementation 'org.springframework.boot:spring-boot-starter-oauth2-client'
+    implementation 'org.springdoc:springdoc-openapi-ui:1.6.12'
+    implementation 'org.springdoc:springdoc-openapi-data-rest:1.6.12'
+    implementation 'org.springdoc:springdoc-openapi-javadoc:1.6.12'
+
 
     //querydsl 추가
     implementation "com.querydsl:querydsl-jpa:${queryDslVersion}"
@@ -47,6 +51,8 @@ dependencies {
     runtimeOnly 'com.mysql:mysql-connector-j'
     runtimeOnly 'org.mariadb.jdbc:mariadb-java-client'
     runtimeOnly 'org.postgresql:postgresql'
+    annotationProcessor 'com.github.therapi:therapi-runtime-javadoc-scribe:0.15.0'
+
     compileOnly 'org.projectlombok:lombok'
     developmentOnly 'org.springframework.boot:spring-boot-devtools'
     annotationProcessor 'org.projectlombok:lombok'

diff --git a/project-board/src/main/java/com/study/projectboard/controller/MainController.java b/project-board/src/main/java/com/study/projectboard/controller/MainController.java
@@ -1,8 +1,20 @@
 package com.study.projectboard.controller;
 
+import com.study.projectboard.dto.response.ArticleCommentResponse;
 import org.springframework.stereotype.Controller;
 import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.ResponseBody;
+import org.springframework.web.bind.annotation.RestController;
 
+import java.time.LocalDateTime;
+
+/**
+ * <p>
+ * 메인 컨트롤러
+ *
+ * <p>
+ * 테스트 중입니다.
+ */
 @Controller
 public class MainController {
 
@@ -11,4 +23,23 @@ public String root(){
         return "forward:/articles";
     }
 
+    /**
+     * 댓글 정보를 열람한다
+     *
+     * @param id 댓글 ID
+     * @return 댓글 응답
+     */
+    @ResponseBody
+    @GetMapping("/test-rest")
+    public ArticleCommentResponse test(Long id) {
+        return ArticleCommentResponse.of(
+                id,
+                "content",
+                LocalDateTime.now(),
+                "e@email.com",
+                "nickname",
+                "hsm"
+        );
+    }
+
 }