전남대 BE_나제법 5주차(3단계)

README.md

@@ -10,4 +10,49 @@
 * 토큰 받기를 읽고 액세스 토큰을 추출한다.
 * 앱 키, 인가 코드가 절대 유출되지 않도록 한다.
   * 특히 시크릿 키는 GitHub나 클라이언트 코드 등 외부에서 볼 수 있는 곳에 추가하지 않는다.  
-* (선택) 인가 코드를 받는 방법이 불편한 경우 카카오 로그인 화면을 구현한다.
+* (선택) 인가 코드를 받는 방법이 불편한 경우 카카오 로그인 화면을 구현한다.
+
+### 🚀 2단계 - 주문하기
+***
+#### 기능 요구 사항
+카카오톡 메시지 API를 사용하여 주문하기 기능을 구현한다.
+
+* 주문할 때 수령인에게 보낼 메시지를 작성할 수 있다.
+* 상품 옵션과 해당 수량을 선택하여 주문하면 해당 상품 옵션의 수량이 차감된다.
+* 해당 상품이 위시 리스트에 있는 경우 위시 리스트에서 삭제한다.
+* 나에게 보내기를 읽고 주문 내역을 카카오톡 메시지로 전송한다.
+  * 메시지는 메시지 템플릿의 기본 템플릿이나 사용자 정의 템플릿을 사용하여 자유롭게 작성한다.  
+
+아래 예시와 같이 HTTP 메시지를 주고받도록 구현한다.
+
+##### Request
+```
+POST /api/orders HTTP/1.1
+Authorization: Bearer {token}
+Content-Type: application/json
+
+{
+    "optionId": 1,
+    "quantity": 2,
+    "message": "Please handle this order with care."
+}
+```
+
+##### Response
+```
+HTTP/1.1 201 Created
+Content-Type: application/json
+
+{
+"id": 1,
+"optionId": 1,
+"quantity": 2,
+"orderDateTime": "2024-07-21T10:00:00",
+"message": "Please handle this order with care."
+}
+```
+### 🚀 3단계 - API 문서 만들기
+***
+#### 기능 요구 사항
+API 사양에 관해 클라이언트와 어떻게 소통할 수 있을까? 
+어떻게 하면 편하게 소통할 수 있을지 고민해 보고 그 방법을 구현한다.

build.gradle

@@ -2,6 +2,7 @@ plugins {
     id 'java'
     id 'org.springframework.boot' version '3.3.1'
     id 'io.spring.dependency-management' version '1.1.5'
+    id 'org.asciidoctor.jvm.convert' version '4.0.3'
 }
 
 group = 'camp.nextstep.edu'
@@ -17,6 +18,13 @@ repositories {
     mavenCentral()
 }
 
+configurations {
+    asciidoctorExt //asciidoctorExt를 configurations로 지정
+    compileOnly {
+        extendsFrom annotationProcessor
+    }
+}
+
 dependencies {
     implementation 'org.springframework.boot:spring-boot-starter-jdbc'
     implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
@@ -31,6 +39,13 @@ dependencies {
     runtimeOnly 'io.jsonwebtoken:jjwt-impl:0.12.6'
     runtimeOnly 'io.jsonwebtoken:jjwt-jackson:0.12.6'
 
+    // Swagger
+    implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.0.4'
+
+    //REST Docs
+    asciidoctorExt 'org.springframework.restdocs:spring-restdocs-asciidoctor'
+    testImplementation 'org.springframework.restdocs:spring-restdocs-mockmvc'
+
     runtimeOnly 'com.h2database:h2'
     testImplementation 'org.springframework.boot:spring-boot-starter-test'
     testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
@@ -45,3 +60,36 @@ dependencyManagement {
 tasks.named('test') {
     useJUnitPlatform()
 }
+
+ext {
+    set('snippetsDir', file("build/generated-snippets")) //snippets 파일이 저장될 경로 snippetsDir로 변수 설정
+}
+
+test {
+    outputs.dir snippetsDir
+    useJUnitPlatform()
+}
+
+asciidoctor {
+    configurations 'asciidoctorExt' //Asciidoctor에서 asciidoctorExt를 사용하도록 설정
+    baseDirFollowsSourceFile()
+    inputs.dir snippetsDir
+    dependsOn test //gradle build 시 test -> asciiDoctor 순서로 실행
+}
+
+asciidoctor.doFirst {
+    delete file('src/main/resources/static/docs') //asciidoctor 실행 전 docs 폴더 삭제
+}
+
+task createDocument(type: Copy) {
+    dependsOn asciidoctor
+    from file("build/docs/asciidoc")
+    into file("src/main/resources/static")
+}
+
+bootJar {
+    dependsOn createDocument //Gradle build 시, createDocument -> bootJar 순으로 실행
+    from("${asciidoctor.outputDir}") {
+        into 'static/docs'
+    }
+}

src/docs/asciidoc/category.adoc

@@ -0,0 +1,19 @@
+== 카테고리 API
+
+=== 카테고리 생성
+operation::category-api-controller-test/create-category[]
+
+=== 카테고리 수정
+operation::category-api-controller-test/update-category[]
+
+=== 카테고리 삭제
+operation::category-api-controller-test/delete-category[]
+
+=== 단일 카테고리 조회
+operation::category-api-controller-test/read-category[]
+
+=== 전체 카테고리 조회
+operation::category-api-controller-test/read-all-categories[]
+
+
+

src/docs/asciidoc/docs.adoc

@@ -0,0 +1,11 @@
+= 카카오 테크 캠퍼스 STEP 2 - REST Docs
+:doctype: book
+:source-highlighter: highlightjs
+:toc: left
+:toclevels: 3
+:sectlinks:
+
+include::product.adoc[]
+include::category.adoc[]
+include::member.adoc[]
+include::login.adoc[]

src/docs/asciidoc/login.adoc

@@ -0,0 +1,4 @@
+== 소셜 로그인 API
+
+=== 카카오 로그인
+operation::login-controller-test/kakao-login[]

src/docs/asciidoc/member.adoc

@@ -0,0 +1,19 @@
+== 회원 API
+
+=== 회원가입
+operation::member-api-controller-test/create-member[]
+
+=== 로그인
+operation::member-api-controller-test/login[]
+
+=== 회원 조회
+operation::member-api-controller-test/read-member[]
+
+=== 위시 상품 조회
+operation::member-api-controller-test/read-wish-product[]
+
+=== 위시 상품 수정
+operation::member-api-controller-test/update-wish-product[]
+
+=== 위시 상품 삭제
+operation::member-api-controller-test/delete-wish-product[]

src/docs/asciidoc/product.adoc

@@ -0,0 +1,35 @@
+== 상품 API
+
+=== 전체 상품 조회
+operation::product-api-controller-test/read-all-products[]
+
+=== 단일 상품 조회
+operation::product-api-controller-test/read-product[]
+
+=== 상품 생성
+operation::product-api-controller-test/create-product[]
+
+=== 상품 수정
+operation::product-api-controller-test/update-product[]
+
+=== 상품 삭제
+operation::product-api-controller-test/delete-product[]
+
+=== 상품 주문
+operation::product-api-controller-test/order-product[]
+
+=== 위시 상품 추가
+operation::product-api-controller-test/create-wish-product[]
+
+=== 상품 옵션 생성
+operation::product-api-controller-test/create-option[]
+
+=== 상품 옵션 조회
+operation::product-api-controller-test/read-options[]
+
+=== 상품 옵션 수정
+operation::product-api-controller-test/update-option[]
+
+=== 상품 옵션 삭제
+operation::product-api-controller-test/delete-option[]
+

src/main/java/gift/authentication/token/Token.java

@@ -15,6 +15,10 @@ public static Token from(String value) {
         return new Token(value);
     }
 
+    public static Token fromBearer(String value) {
+        return new Token(value.replace("Bearer ", ""));
+    }
+
     public String getValue() {
         return value;
     }

src/main/java/gift/config/KakaoProperties.java

@@ -1,5 +1,6 @@
 package gift.config;
 
+import java.net.URI;
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.boot.context.properties.bind.ConstructorBinding;
 
@@ -13,17 +14,20 @@ public class KakaoProperties {
     private final String userInfoUrl;
     private final String tokenUrl;
     private final String responseType;
+    private final String messageUrl;
 
     @ConstructorBinding
     public KakaoProperties(String clientId, String redirectUri, String contentType,
-        String grantType, String userInfoUrl, String tokenUrl, String responseType) {
+        String grantType, String userInfoUrl, String tokenUrl, String responseType,
+        String messageUrl) {
         this.clientId = clientId;
         this.redirectUri = redirectUri;
         this.contentType = contentType;
         this.grantType = grantType;
         this.userInfoUrl = userInfoUrl;
         this.tokenUrl = tokenUrl;
         this.responseType = responseType;
+        this.messageUrl = messageUrl;
     }
 
     public String getClientId() {
@@ -53,4 +57,20 @@ public String getTokenUrl() {
     public String getResponseType() {
         return responseType;
     }
+
+    public String getMessageUrl() {
+        return messageUrl;
+    }
+
+    public URI getUserInfoUrlAsUri() {
+        return URI.create(userInfoUrl);
+    }
+
+    public URI getTokenUrlAsUri() {
+        return URI.create(tokenUrl);
+    }
+
+    public URI getMessageUrlAsUri() {
+        return URI.create(messageUrl);
+    }
 }