Merge pull request #169 from nhnacademy-be4-ckin/develop

[DEPLOY] 6차 배포

.github/workflows/maven.yml

@@ -10,7 +10,7 @@ name: Docker Image CI
 
 on:
   push:
-    branches: [ "main" ]
+    branches: [ "develop" ]
   pull_request:
     branches: [ "main" ]
 

api.iml

@@ -3,6 +3,7 @@
   <component name="AdditionalModuleElements">
     <content url="file://$MODULE_DIR$" dumb="true">
       <sourceFolder url="file://$MODULE_DIR$/target/generated-sources/annotations" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/target/generated-sources/java" isTestSource="false" />
     </content>
   </component>
   <component name="CheckStyle-IDEA-Module" serialisationVersion="2">
@@ -22,9 +23,6 @@
       </configuration>
     </facet>
   </component>
-  <component name="SonarLintModuleSettings">
-    <option name="uniqueId" value="d4b67758-f8b2-46a8-9c6d-387fb4127a78" />
-  </component>
   <component name="SonarLintModuleSettings">
     <option name="uniqueId" value="eb3eb716-12c5-4397-beab-1680eb73f509" />
   </component>

pom.xml

@@ -87,6 +87,13 @@
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-actuator</artifactId>
         </dependency>
+
+        <!-- Rest Docs -->
+        <dependency>
+            <groupId>org.springframework.restdocs</groupId>
+            <artifactId>spring-restdocs-mockmvc</artifactId>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
     <dependencyManagement>
@@ -173,17 +180,14 @@
                 <groupId>com.mysema.maven</groupId>
                 <artifactId>apt-maven-plugin</artifactId>
                 <version>1.1.3</version>
-                <configuration>
-                    <processor>com.querydsl.apt.jpa.JPAAnnotationProcessor</processor>
-                </configuration>
                 <executions>
                     <execution>
-                        <phase>generate-sources</phase>
                         <goals>
                             <goal>process</goal>
                         </goals>
                         <configuration>
-                            <outputDirectory>target/generated-sources/annotations</outputDirectory>
+                            <outputDirectory>target/generated-sources/java</outputDirectory>
+                            <processor>com.querydsl.apt.jpa.JPAAnnotationProcessor</processor>
                         </configuration>
                     </execution>
                 </executions>
@@ -193,6 +197,56 @@
                 <artifactId>maven-compiler-plugin</artifactId>
                 <version>3.10.1</version>
             </plugin>
+            <plugin>
+                <groupId>org.asciidoctor</groupId>
+                <artifactId>asciidoctor-maven-plugin</artifactId>
+                <version>2.2.1</version>
+                <executions>
+                    <execution>
+                        <id>generate-docs</id>
+                        <phase>prepare-package</phase>
+                        <goals>
+                            <goal>process-asciidoc</goal>
+                        </goals>
+                        <configuration>
+                            <backend>html</backend>
+                            <doctype>book</doctype>
+                        </configuration>
+                    </execution>
+                </executions>
+                <dependencies>
+                    <dependency>
+                        <groupId>org.springframework.restdocs</groupId>
+                        <artifactId>spring-restdocs-asciidoctor</artifactId>
+                        <version>${spring-restdocs.version}</version>
+                    </dependency>
+                </dependencies>
+            </plugin>
+            <plugin>
+                <artifactId>maven-resources-plugin</artifactId>
+                <version>2.7</version>
+                <executions>
+                    <execution>
+                        <id>copy-resources</id>
+                        <phase>prepare-package</phase>
+                        <goals>
+                            <goal>copy-resources</goal>
+                        </goals>
+                        <configuration>
+                            <outputDirectory>
+                                ${project.build.outputDirectory}/static/docs
+                            </outputDirectory>
+                            <resources>
+                                <resource>
+                                    <directory>
+                                        ${project.build.directory}/generated-docs
+                                    </directory>
+                                </resource>
+                            </resources>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
         </plugins>
     </build>
 </project>

src/docs/asciidoc/book.adoc

@@ -0,0 +1,80 @@
+== 책
+
+=== 책 Id로 책 정보 조회
+
+==== Request
+
+include::{snippets}/book/getBookById/success/http-request.adoc[]
+
+==== Path Parameters
+
+include::{snippets}/book/getBookById/success/path-parameters.adoc[]
+
+
+==== Response
+
+include::{snippets}/book/getBookById/success/http-response.adoc[]
+
+==== Response fields
+
+include::{snippets}/book/getBookById/success/response-fields.adoc[]
+
+{empty} +
+
+=== 책 생성 요청 성공
+
+==== Request
+
+include::{snippets}/book/createBook/success/http-request.adoc[]
+
+==== Request Parts
+
+include::{snippets}/book/createBook/success/request-parts.adoc[]
+
+
+==== Request Parts
+
+include::{snippets}/book/createBook/success/request-part-requestDto-fields.adoc[]
+
+==== Response
+
+include::{snippets}/book/createBook/success/http-response.adoc[]
+
+=== 책 정보 업데이트
+
+==== Request
+
+include::{snippets}/book/updateBook/success/http-request.adoc[]
+
+==== Path Parameters
+
+include::{snippets}/book/updateBook/success/path-parameters.adoc[]
+
+==== Request Fields
+
+include::{snippets}/book/updateBook/success/request-fields.adoc[]
+
+==== Response
+
+include::{snippets}/book/updateBook/success/http-response.adoc[]
+
+{empty} +
+
+=== 카테고리 ID로 책 검색
+
+==== Request
+
+include::{snippets}/book/findByCategoryId/http-request.adoc[]
+
+==== Request Parameters
+
+include::{snippets}/book/findByCategoryId/request-parameters.adoc[]
+
+==== Response
+
+include::{snippets}/book/findByCategoryId/http-response.adoc[]
+
+==== Response Fields
+
+include::{snippets}/book/findByCategoryId/response-fields.adoc[]
+

src/docs/asciidoc/delivery-policy.adoc

@@ -0,0 +1,80 @@
+== 배송비 정책
+
+=== 배송비 정책 생성 - 성공
+
+==== Request
+
+include::{snippets}/delivery-policy/createDeliveryPolicy/success/http-request.adoc[]
+
+==== Response
+
+include::{snippets}/delivery-policy/createDeliveryPolicy/success/http-response.adoc[]
+
+==== Request Parameters
+
+include::{snippets}/delivery-policy/createDeliveryPolicy/success/request-fields.adoc[]
+
+{empty} +
+
+=== 배송비 정책 생성 - 실패 (Validation Error)
+
+==== Request
+
+include::{snippets}/delivery-policy/createDeliveryPolicy/validation-fail/http-request.adoc[]
+
+==== Response
+
+include::{snippets}/delivery-policy/createDeliveryPolicy/validation-fail/http-response.adoc[]
+
+{empty} +
+
+=== 배송비 정책 전체 조회
+
+==== Request
+
+include::{snippets}/delivery-policy/getDeliveryPolicyList/success/http-request.adoc[]
+
+==== Response
+
+include::{snippets}/delivery-policy/getDeliveryPolicyList/success/http-response.adoc[]
+
+{empty} +
+
+=== 배송비 정책 상세 조회
+
+==== Request
+
+include::{snippets}/delivery-policy/getDeliveryPolicy/success/http-request.adoc[]
+
+==== Response
+
+include::{snippets}/delivery-policy/getDeliveryPolicy/success/http-response.adoc[]
+
+{empty} +
+
+=== 배송비 정책 수정 - 성공
+
+==== Request
+
+include::{snippets}/delivery-policy/updateDeliveryPolicy/success/http-request.adoc[]
+
+==== Response
+
+include::{snippets}/delivery-policy/updateDeliveryPolicy/success/http-response.adoc[]
+
+==== Request Parameters
+
+include::{snippets}/delivery-policy/updateDeliveryPolicy/success/request-fields.adoc[]
+
+{empty} +
+
+
+=== 배송비 정책 수정 - 실패 (Validation Error)
+
+==== Request
+
+include::{snippets}/delivery-policy/updateDeliveryPolicy/validation-fail/http-request.adoc[]
+
+==== Response
+
+include::{snippets}/delivery-policy/updateDeliveryPolicy/validation-fail/http-response.adoc[]

src/docs/asciidoc/index.adoc

@@ -0,0 +1,63 @@
+= CKIN REST-API docs
+:doctype: book
+:icons: font
+:source-highlighter: highlightjs
+:toc-title: 목차
+:toc: left
+:toclevels: 5
+
+= 1. 개요
+이 API 문서는 CKIN(체크인) 팀의 API 문서를 유용하게 볼수 있게 도와줍니다.
+
+NOTE: 기본적인 구성은 다음과 같습니다
+
+### 1.1 API 구성
+
+```
+/api/**
+```
+
+### 1.2 Domain Name 구성
+
+```
+ckin.store
+```
+
+### 1.3 참여 인원
+
+[cols=2*]
+|===
+| *이름*
+| *GitHub 주소*
+
+| 김준현
+| https://github.com/dduneon
+
+| 정승조
+| https://github.com/f1v3-dev
+
+| 이진우
+| https://github.com/devhomh
+
+| 나국로
+| https://github.com/nayoseb
+
+| 이가은
+| https://github.com/nueag
+|===
+
+'''
+
+= 2. API
+
+include::tag.adoc[]
+
+include::delivery-policy.adoc[]
+
+include::packaging.adoc[]
+
+include::payment.adoc[]
+
+include::point-policy.adoc[]
+
+include::sale.adoc[]