API - v0.0.1

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,15 +1,10 @@
-## 📝 PR Summary
+# 💡 PR Summary - <!--{ 작업 내용 }-->
+<!-- 어떤 작업에 대한 PR 인지 위 주석에 적어주세요 -->
+## 개요
+- close #issueNumber
 
-<!-- 예시) 상품 가격 천단위 humanize intcomma 적용 -->
+## 작업사항
+- 내용을 적어주세요.
 
-#### 🌲 Working Branch
-
-<!-- 예시) hotfix/price_comma -->
-
-#### 🌲 TODOs
-
-<!-- 예시) * 상품 스토어 리스트 가격 천단위 표기 적용 -->
-
-### Related Issues
-
-<!-- 예시) * resolves #71 -->
+## 변경로직
+- 내용을 적어주세요.

.github/workflows/CI.yml

@@ -0,0 +1,35 @@
+name: CI
+
+on:
+  pull_request:
+    branch: 'dev'
+    types: [ opened, synchronize, reopened ]
+
+jobs:
+  build:
+    name: CI
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Set up Java
+        uses: actions/setup-java@v3
+        with:
+          java-version: 17
+          distribution: 'corretto'
+
+      - name: Grant execute permission for gradlew
+        run: chmod +x gradlew
+
+      - name: Build with Gradle
+        run: ./gradlew :Api:build
+
+      - name: Cache Gradle packages
+        uses: actions/cache@v1
+        with:
+          path: ~/.gradle/caches
+          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle') }}
+          restore-keys: ${{ runner.os }}-gradle

.github/workflows/DevCICD.yml

@@ -0,0 +1,79 @@
+name: DEV CI/CD
+
+on:
+  push:
+    branches: dev
+
+env:
+  PROFILE_DEV: dev
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: checkout
+        uses: actions/checkout@v2
+
+      - name: Set up Java
+        uses: actions/setup-java@v3
+        with:
+          java-version: 17
+          distribution: 'corretto'
+
+      - name: Grant execute permission for gradlew
+        run: chmod +x ./gradlew
+
+      - name: Build with Gradle
+        run: ./gradlew :Api:build
+
+      - name: Docker build
+        run: |
+          docker login -u ${{ secrets.DOCKER_USERNAME }} -p ${{ secrets.DOCKER_PASSWORD }}
+          docker build -t ${{ secrets.DOCKER_USERNAME }}/${{ secrets.DOCKER_DEV_REPO }} .
+          docker push ${{ secrets.DOCKER_USERNAME }}/${{ secrets.DOCKER_DEV_REPO }}:latest
+
+      - name: Get Public IP
+        id: publicip
+        run: |
+          response=$(curl -s canhazip.com)
+          echo "ip='$response'" >> "$GITHUB_OUTPUT"
+
+      - name: Configure AWS Credentials
+        uses: aws-actions/configure-aws-credentials@v1
+        with:
+          aws-access-key-id: ${{ secrets.AWS_DEV_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_DEV_SECRET_ACCESS_KEY }}
+          aws-region: ${{ secrets.AWS_REGION }}
+
+      - name: Add GitHub IP to AWS
+        run: |
+          aws ec2 authorize-security-group-ingress --group-id ${{ secrets.AWS_DEV_SG_ID }} --protocol tcp --port ${{ secrets.EC2_SSH_PORT }} --cidr ${{ steps.publicip.outputs.ip  }}/32
+
+      - name: Deploy
+        uses: appleboy/ssh-action@master
+        with:
+          host: ${{ secrets.EC2_DEV_HOST }}
+          username: ${{ secrets.EC2_DEV_USERNAME }}
+          key: ${{ secrets.EC2_DEV_KEY }}
+          port: ${{ secrets.EC2_SSH_PORT }}
+          timeout: 60s
+          script: |
+            cd allchive-dev
+
+            sudo touch .env
+            echo "${{ secrets.ENV_DEV_VARS }}" | sudo tee .env > /dev/null
+
+            sudo docker stop $(sudo docker ps -a -q)
+            sudo docker rm $(sudo docker ps -a -q)
+            sudo docker rmi $(sudo docker images -q)
+            sudo docker pull ${{ secrets.DOCKER_USERNAME }}/${{ secrets.DOCKER_DEV_REPO }}:latest
+            sudo docker-compose -f ~/allchive-dev/docker-compose.yml --env-file ~/allchive-dev/.env up --build -d
+            sudo docker system prune --all -f
+
+      - name: Remove IP FROM security group
+        run: |
+          aws ec2 revoke-security-group-ingress --group-id ${{ secrets.AWS_DEV_SG_ID }} --protocol tcp --port ${{ secrets.EC2_SSH_PORT }} --cidr ${{ steps.publicip.outputs.ip  }}/32

.github/workflows/ProdCICD.yml

@@ -0,0 +1,79 @@
+name: PROD CI/CD
+
+on:
+  push:
+    branches: prod
+
+env:
+  PROFILE_PROD: prod
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: checkout
+        uses: actions/checkout@v2
+
+      - name: Set up Java
+        uses: actions/setup-java@v3
+        with:
+          java-version: 17
+          distribution: 'corretto'
+
+      - name: Grant execute permission for gradlew
+        run: chmod +x ./gradlew
+
+      - name: Build with Gradle
+        run: ./gradlew :Api:build
+
+      - name: Docker build
+        run: |
+          docker login -u ${{ secrets.DOCKER_USERNAME }} -p ${{ secrets.DOCKER_PASSWORD }}
+          docker build -t ${{ secrets.DOCKER_USERNAME }}/${{ secrets.DOCKER_PROD_REPO }} .
+          docker push ${{ secrets.DOCKER_USERNAME }}/${{ secrets.DOCKER_PROD_REPO }}:latest
+
+      - name: Get Public IP
+        id: publicip
+        run: |
+          response=$(curl -s canhazip.com)
+          echo "ip='$response'" >> "$GITHUB_OUTPUT"
+
+      - name: Configure AWS Credentials
+        uses: aws-actions/configure-aws-credentials@v1
+        with:
+          aws-access-key-id: ${{ secrets.AWS_PROD_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_PROD_SECRET_ACCESS_KEY }}
+          aws-region: ${{ secrets.AWS_REGION }}
+
+      - name: Add GitHub IP to AWS
+        run: |
+          aws ec2 authorize-security-group-ingress --group-id ${{ secrets.AWS_PROD_SG_ID }} --protocol tcp --port ${{ secrets.EC2_SSH_PORT }} --cidr ${{ steps.publicip.outputs.ip  }}/32
+
+      - name: Deploy
+        uses: appleboy/ssh-action@master
+        with:
+          host: ${{ secrets.EC2_PROD_HOST }}
+          username: ${{ secrets.EC2_PROD_USERNAME }}
+          key: ${{ secrets.EC2_PROD_KEY }}
+          port: ${{ secrets.EC2_SSH_PORT }}
+          timeout: 60s
+          script: |
+            cd allchive-prod
+
+            sudo touch .env
+            echo "${{ secrets.ENV_PROD_VARS }}" | sudo tee .env > /dev/null
+
+            sudo docker stop $(sudo docker ps -a -q)
+            sudo docker rm $(sudo docker ps -a -q)
+            sudo docker rmi $(sudo docker images -q)
+            sudo docker pull ${{ secrets.DOCKER_USERNAME }}/${{ secrets.DOCKER_PROD_REPO }}:latest
+            sudo docker-compose -f ~/allchive-prod/docker-compose.yml --env-file ~/allchive-prod/.env up --build -d
+            sudo docker system prune --all -f
+
+      - name: Remove IP FROM security group
+        run: |
+          aws ec2 revoke-security-group-ingress --group-id ${{ secrets.AWS_PROD_SG_ID }} --protocol tcp --port ${{ secrets.EC2_SSH_PORT }} --cidr ${{ steps.publicip.outputs.ip  }}/32

.gitignore

@@ -39,4 +39,7 @@ out/
 .DS_Store
 
 .env
-.env.*
+.env.*
+
+
+Domain/src/main/generated/**/*.java

Api/build.gradle

@@ -11,11 +11,11 @@ repositories {
 
 dependencies {
     implementation 'org.springframework.boot:spring-boot-starter-web'
-    implementation 'org.springframework.boot:spring-boot-starter-validation'
     implementation 'org.springframework.boot:spring-boot-starter-security'
+
+    // swagger
     implementation 'org.springdoc:springdoc-openapi-ui:1.6.12'
-    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.9.2'
-    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.9.2'
+
     implementation project(':Domain')
     implementation project(':Core')
     implementation project(':Infrastructure')

Api/src/main/java/allchive/server/ApiApplication.java

@@ -7,7 +7,6 @@
 @SpringBootApplication
 public class ApiApplication {
     public static void main(String[] args) {
-        System.out.println("Hello world!");
         SpringApplication.run(ApiApplication.class, args);
     }
 }

Api/src/main/java/allchive/server/api/SchedulerPackageLocation.java

@@ -0,0 +1,3 @@
+package allchive.server.api;
+
+public interface SchedulerPackageLocation {}

Api/src/main/java/allchive/server/api/archiving/controller/ArchivingController.java

@@ -0,0 +1,115 @@
+package allchive.server.api.archiving.controller;
+
+
+import allchive.server.api.archiving.model.dto.request.CreateArchivingRequest;
+import allchive.server.api.archiving.model.dto.request.UpdateArchivingRequest;
+import allchive.server.api.archiving.model.dto.response.ArchivingContentsResponse;
+import allchive.server.api.archiving.model.dto.response.ArchivingResponse;
+import allchive.server.api.archiving.model.dto.response.ArchivingTitleResponse;
+import allchive.server.api.archiving.service.*;
+import allchive.server.api.common.slice.SliceResponse;
+import allchive.server.domain.domains.archiving.domain.enums.Category;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springdoc.api.annotations.ParameterObject;
+import org.springframework.data.domain.Pageable;
+import org.springframework.data.web.PageableDefault;
+import org.springframework.web.bind.annotation.*;
+
+@RestController
+@RequestMapping("/archivings")
+@RequiredArgsConstructor
+@Slf4j
+@Tag(name = "3. [archiving]")
+public class ArchivingController {
+    private final CreateArchivingUseCase createArchivingUseCase;
+    private final UpdateArchivingUseCase updateArchivingUseCase;
+    private final DeleteArchivingUseCase deleteArchivingUseCase;
+    private final GetArchivingUseCase getArchivingUseCase;
+    private final GetArchivedArchivingUseCase getArchivedArchivingUseCase;
+    private final GetScrapArchivingUseCase getScrapArchivingUseCase;
+    private final GetArchivingTitleUseCase getArchivingTitleUseCase;
+    private final GetArchivingContentsUseCase getArchivingContentsUseCase;
+    private final UpdateArchivingScrapUseCase updateArchivingScrapUseCase;
+    private final UpdateArchivingPinUseCase updateArchivingPinUseCase;
+
+    @Operation(summary = "아카이빙을 생성합니다.")
+    @PostMapping()
+    public void createArchiving(@RequestBody CreateArchivingRequest createArchivingRequest) {
+        createArchivingUseCase.execute(createArchivingRequest);
+    }
+
+    @Operation(summary = "아카이빙을 수정합니다.")
+    @PatchMapping(value = "/{archivingId}")
+    public void updateArchiving(
+            @PathVariable("archivingId") Long archivingId,
+            @RequestBody UpdateArchivingRequest updateArchivingRequest) {
+        updateArchivingUseCase.execute(archivingId, updateArchivingRequest);
+    }
+
+    @Operation(summary = "아카이빙을 삭제합니다.")
+    @DeleteMapping(value = "/{archivingId}")
+    public void deleteArchiving(@PathVariable("archivingId") Long archivingId) {
+        deleteArchivingUseCase.execute(archivingId);
+    }
+
+    @Operation(
+            summary = "주제별 아카이빙 리스트를 가져옵니다.",
+            description = "sort parameter는 입력하지 말아주세요! sorting : 스크랩 여부 -> 스크랩 수 -> 생성일자")
+    @GetMapping()
+    public SliceResponse<ArchivingResponse> getArchiving(
+            @RequestParam("category") Category category,
+            @ParameterObject @PageableDefault(size = 10) Pageable pageable) {
+        return getArchivingUseCase.execute(category, pageable);
+    }
+
+    @Operation(
+            summary = "내 아카이빙 주제별 아카이빙 리스트를 가져옵니다.",
+            description = "sort parameter는 입력하지 말아주세요! sorting : 고정 -> 스크랩 수 -> 생성일자")
+    @GetMapping(value = "/me/archiving")
+    public SliceResponse<ArchivingResponse> getArchivedArchiving(
+            @RequestParam("category") Category category,
+            @ParameterObject @PageableDefault(size = 10) Pageable pageable) {
+        return getArchivedArchivingUseCase.execute(category, pageable);
+    }
+
+    @Operation(
+            summary = "스크랩 주제별 아카이빙 리스트를 가져옵니다.",
+            description = "sort parameter는 입력하지 말아주세요! sorting : 스크랩 수 -> 생성일자")
+    @GetMapping(value = "/me/scrap")
+    public SliceResponse<ArchivingResponse> getScrapArchiving(
+            @RequestParam("category") Category category,
+            @ParameterObject @PageableDefault(size = 10) Pageable pageable) {
+        return getScrapArchivingUseCase.execute(category, pageable);
+    }
+
+    @Operation(summary = "사용 중인 주제 & 아카이빙 리스트를 가져옵니다. (컨텐츠 추가 시 사용)")
+    @GetMapping(value = "/lists")
+    public ArchivingTitleResponse getScrapArchiving() {
+        return getArchivingTitleUseCase.execute();
+    }
+
+    @Operation(summary = "아카이빙별 컨텐츠 리스트를 가져옵니다.")
+    @GetMapping(value = "/{archivingId}/contents")
+    public ArchivingContentsResponse getArchivingContents(
+            @PathVariable("archivingId") Long archivingId,
+            @ParameterObject @PageableDefault(size = 10) Pageable pageable) {
+        return getArchivingContentsUseCase.execute(archivingId, pageable);
+    }
+
+    @Operation(summary = "아카이빙을 스크랩합니다.", description = "스크랩 취소면 cancel에 true 값 보내주세요")
+    @PatchMapping(value = "/{archivingId}/scrap")
+    public void updateArchivingScrap(
+            @RequestParam("cancel") Boolean cancel, @PathVariable("archivingId") Long archivingId) {
+        updateArchivingScrapUseCase.execute(archivingId, cancel);
+    }
+
+    @Operation(summary = "아카이빙을 고정합니다.", description = "고정 취소면 cancel에 true 값 보내주세요")
+    @PatchMapping(value = "/{archivingId}/pin")
+    public void updateArchivingPin(
+            @RequestParam("cancel") Boolean cancel, @PathVariable("archivingId") Long archivingId) {
+        updateArchivingPinUseCase.execute(archivingId, cancel);
+    }
+}