Merge pull request #215 from woowacourse-teams/develop

스프린트 3 Merge

Author: tco0427

.github/workflows/backend.yml

@@ -27,7 +27,7 @@ jobs:
           distribution: 'temurin'
 
       - name: Build
-        run: ./gradlew build --exclude-task test
+        run: ./gradlew build --exclude-task test --exclude-task asciidoctor
 
       - name: Test  
         env: 

.github/workflows/deploy-backend-dev.yml

@@ -29,7 +29,7 @@ jobs:
           distribution: 'temurin'
 
       - name: Build
-        run: ./gradlew build --exclude-task test
+        run: ./gradlew build --exclude-task test --exclude-task asciidoctor
 
       - name: Test  
         env: 

.github/workflows/deploy-frontend-dev.yml

@@ -0,0 +1,43 @@
+name: Deploy Frontend Dev
+
+on:
+  push:
+    branches: ["develop"]
+
+defaults:
+  run:
+    working-directory: frontend
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [16.x]
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: "npm"
+          cache-dependency-path: "./frontend/package-lock.json"
+
+      - name: Install
+        run: npm install
+
+      - name: Build
+        run: npm run build-dev
+
+      - uses: cypress-io/github-action@v2
+        with:
+          start: npm run start
+          wait-on: "http://localhost:3000"
+          working-directory: frontend
+          config-file: cypress.config.ts
+
+      - name: Deploy
+        run: curl ${{ secrets.FE_DEV_DEPLOY_REQUEST_URL }}

.github/workflows/frontend.yml

@@ -1,8 +1,6 @@
 name: frontend
 
 on:
-  push:
-    branches: [ "main", "develop" ]
   pull_request:
     branches: [ "main", "develop" ]
 

backend/.gitignore

@@ -38,3 +38,4 @@ out/
 
 /src/main/resources/application-security.yml
 /src/test/resources/application-security.yml
+/src/main/resources/static/docs/index.html

backend/build.gradle

@@ -1,14 +1,8 @@
-buildscript {
-    ext {
-        queryDslVersion = "5.0.0"
-    }
-}
-
 plugins {
     id 'org.springframework.boot' version '2.6.9'
     id 'io.spring.dependency-management' version '1.0.11.RELEASE'
     id 'java'
-    id "com.ewerk.gradle.plugins.querydsl" version "1.0.10"
+    id 'org.asciidoctor.jvm.convert' version "3.3.2"
 }
 
 group = 'com.woowacourse'
@@ -19,6 +13,7 @@ configurations {
     compileOnly {
         extendsFrom annotationProcessor
     }
+    asciidoctorExtensions
 }
 
 repositories {
@@ -42,32 +37,45 @@ dependencies {
     runtimeOnly 'com.h2database:h2'
     runtimeOnly 'mysql:mysql-connector-java'
 
-    // querydsl
-    implementation "com.querydsl:querydsl-jpa:${queryDslVersion}"
-    implementation "com.querydsl:querydsl-apt:${queryDslVersion}"
+    asciidoctorExtensions 'org.springframework.restdocs:spring-restdocs-asciidoctor'
+    testImplementation 'org.springframework.restdocs:spring-restdocs-restassured'
+}
+
+ext {
+    set('snippetsDir', file("build/generated-snippets"))
 }
 
 tasks.named('test') {
+    outputs.dir snippetsDir
     useJUnitPlatform()
     systemProperties = System.getProperties()
+    finalizedBy 'asciidoctor'
 }
 
-// querydsl
-def querydslDir = "$buildDir/generated/querydsl"
+asciidoctor.doFirst {
+    delete file('src/main/resources/static/docs')
+}
 
-querydsl {
-    jpa = true
-    querydslSourcesDir = querydslDir
+asciidoctor {
+    inputs.dir snippetsDir
+    configurations 'asciidoctorExtensions'
+    dependsOn test
 }
-sourceSets {
-    main.java.srcDir querydslDir
+
+task createDocument(type: Copy) {
+    dependsOn asciidoctor
+
+    from file("build/docs/asciidoc")
+    into file("src/main/resources/static/docs")
 }
-compileQuerydsl {
-    options.annotationProcessorPath = configurations.querydsl
+
+task moveDocument(type: Copy) {
+    dependsOn createDocument
+
+    from file("build/docs/asciidoc")
+    into file("build/resources/main/static/docs")
 }
-configurations {
-    compileOnly {
-        extendsFrom annotationProcessor
-    }
-    querydsl.extendsFrom compileClasspath
+
+bootJar {
+    dependsOn moveDocument
 }

backend/src/docs/asciidoc/index.adoc

@@ -0,0 +1,73 @@
+:doctype: book
+:source-highlighter: highlightjs
+:toc: left
+:toclevels: 2
+:sectlinks:
+
+= MOAMOA
+
+[[Auth]]
+== 인증
+
+=== Github 로그인
+operation::auth/login[snippets='http-request,request-parameters,http-response,response-fields']
+
+[[Member]]
+== 회원
+
+=== 스터디에서 나의 Role 확인
+operation::members/me/role[snippets='http-request,request-headers,request-parameters,http-response,response-fields']
+
+=== 로그인한 사용자 정보 조회
+operation::members/me[snippets='http-request,request-headers,http-response']
+
+[[Study]]
+== 스터디
+
+=== 스터디 생성
+operation::studies/create[snippets='http-request,request-headers,http-response']
+
+=== 스터디 참여
+operation::studies/participant[snippets='http-request,http-response']
+
+=== 스터디 목록 조회
+operation::studies/summary[snippets='http-request,http-response']
+
+=== 스터디 제목 검색
+operation::studies/search[snippets='http-request,http-response']
+
+=== 스터디 제목 검색 (필터링)
+operation::studies/searchWithTags[snippets='http-request,http-response']
+
+=== 스터디 세부 페이지
+operation::studies/details[snippets='http-request,http-response']
+
+=== 참여한 스터디 목록 조회
+operation::studies/myStudy[snippets='http-request,http-response']
+
+[[Tag]]
+== 태그
+
+=== 태그 목록 조회
+operation::tags/list[snippets='http-request,http-response']
+
+=== 태그 목록 검색
+operation::tags/search[snippets='http-request,http-response']
+
+[[Review]]
+== 스터디 후기
+
+=== 후기 작성
+operation::reviews/create[snippets='http-request,http-response']
+
+=== 후기 전체 조회
+operation::reviews/list[snippets='http-request,http-response']
+
+=== 후기 특정 개수 조회
+operation::reviews/list-certain-number[snippets='http-request,http-response']
+
+=== 리뷰 수정
+operation::reviews/update[snippets='http-request,http-response']
+
+=== 리뷰 삭제
+operation::reviews/delete[snippets='http-request,http-response']