1차 개발 완료

.github/workflows/build_release_and_notify.yml

@@ -1,16 +1,17 @@
 # .github/workflows/build_release_and_notify.yml
-
 name: Build and Deploy Executables
 
 on:
   release:
     types: [published] # Release가 'published' 상태가 될 때 트리거
+  workflow_dispatch:
 
 jobs:
   # ==================================
   #    파이프라인 시작 알림
   # ==================================
   start:
+    if: github.event_name == 'release'
     runs-on: ubuntu-latest
     steps:
       - name: Send Pipeline Start Notification
@@ -28,7 +29,6 @@ jobs:
   #    실행 파일 빌드
   # ==================================
   build:
-    needs: start
     strategy:
       matrix:
         os: [macos-latest, windows-latest]
@@ -75,6 +75,8 @@ jobs:
       # 6. PyInstaller를 사용해 파이썬 코드를 실행 파일로 만듭니다.
       - name: Build executable with PyInstaller
         shell: bash
+        env:
+          ENV_AES256_KEY: ${{ secrets.ENV_AES256_KEY }}
         run: poetry run pyinstaller --clean --additional-hooks-dir ./hooks --add-data "app/assets:assets" --onefile --name ${{ env.EXE_NAME }} app/main.py
 
       # 7. 빌드된 실행 파일을 다음 단계(deploy)에서 사용할 수 있도록 아티팩트로 업로드합니다.
@@ -90,6 +92,7 @@ jobs:
   # ==================================
   deploy:
     needs: build
+    if: github.event_name == 'release'
     runs-on: ubuntu-latest
 
     steps:
@@ -119,7 +122,7 @@ jobs:
           if git diff-index --quiet HEAD; then
             echo "No changes to commit to QGenie APP repository."
           else
-            git commit -m "feat: API 실행 파일 업데이트 (${{ github.ref_name }})"
+            git commit -m "feat: Update API executable (${{ github.ref_name }})"
             git push
           fi
 
@@ -129,7 +132,7 @@ jobs:
   finish:
     needs: deploy
     runs-on: ubuntu-latest
-    if: always()
+    if: always() && github.event_name == 'release'
 
     steps:
       - name: Send Success Notification

.github/workflows/pr_bot.yml

@@ -7,6 +7,10 @@ on:
     types: [opened, closed, reopened, synchronize]
   issue_comment:
     types: [created]
+  pull_request_review:
+    types: [submitted]
+  pull_request_review_comment:
+    types: [created]
 
 jobs:
   notify:
@@ -23,7 +27,7 @@ jobs:
             "username": "GitHub PR 봇",
             "embeds": [{
               "title": "Pull Request #${{ github.event.pull_request.number }}: ${{ github.event.pull_request.title }}",
-              "description": "**${{ github.actor }}**님이 Pull Request를 생성하거나 업데이트했습니다.",
+              "description": "**${{ github.actor }}**님이 Pull Request를 생성 또는 업데이트했습니다.",
               "url": "${{ github.event.pull_request.html_url }}",
               "color": 2243312
             }]
@@ -84,3 +88,41 @@ jobs:
             }]
           }' \
           ${{ secrets.DISCORD_WEBHOOK_URL }}
+
+      # ----------------------------
+      #   리뷰 제출(Submit Review) 알림
+      # ----------------------------
+      - name: Send Review Submitted Notification
+        if: github.event_name == 'pull_request_review' && github.event.action == 'submitted'
+        run: |
+          REVIEW_BODY=$(echo "${{ github.event.review.body }}" | sed 's/"/\\"/g' | sed ':a;N;$!ba;s/\n/\\n/g')
+          curl -X POST -H "Content-Type: application/json" \
+          -d "{
+            \"username\": \"GitHub 리뷰 봇\",
+            \"embeds\": [{
+              \"title\": \"New Review on PR #${{ github.event.pull_request.number }}\",
+              \"description\": \"**${{ github.actor }}**님이 리뷰를 남겼습니다: \\n${REVIEW_BODY}\",
+              \"url\": \"${{ github.event.review.html_url }}\",
+              \"color\": 16776960
+            }]
+          }" \
+          ${{ secrets.DISCORD_WEBHOOK_URL }}
+
+      # -------------------------
+      #   리뷰 댓글에 대한 답글 알림
+      # -------------------------
+      - name: Send Review Comment Notification
+        if: github.event_name == 'pull_request_review_comment' && github.event.action == 'created'
+        run: |
+          COMMENT_BODY=$(echo "${{ github.event.comment.body }}" | sed 's/"/\\"/g' | sed ':a;N;$!ba;s/\n/\\n/g')
+          curl -X POST -H "Content-Type: application/json" \
+          -d "{
+            \"username\": \"GitHub 댓글 봇\",
+            \"embeds\": [{
+              \"title\": \"New Reply on PR #${{ github.event.pull_request.number }}\",
+              \"description\": \"**${{ github.actor }}**님의 새 답글: \\n${COMMENT_BODY}\",
+              \"url\": \"${{ github.event.comment.html_url }}\",
+              \"color\": 15105570
+            }]
+          }" \
+          ${{ secrets.DISCORD_WEBHOOK_URL }}

.pre-commit-config.yaml

@@ -2,7 +2,7 @@ repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: "v0.12.2" # ruff 버전에 맞게 수정
     hooks:
-      - id: ruff
+      - id: ruff-check
         args: ["--fix"] # 자동 수정 적용
 
   - repo: https://github.com/psf/black

README.md

@@ -32,7 +32,7 @@
 
     ```bash
     git clone https://github.com/Queryus/QGenie_api.git
-    cd app # 복제된 저장소 디렉토리로 이동
+    cd QGenie_api
 
     ```
 
@@ -88,13 +88,13 @@
 
    ```bash
    poetry shell
-   uvicorn main:app --reload
+   uvicorn app.main:app --host 0.0.0.0 --port 39722 --reload
    ```
 
    또는 Poetry Run을 사용하여 직접 실행할 수 있습니다.
 
    ```bash
-   poetry run uvicorn main:app --reload
+   poetry run uvicorn main:app --host 0.0.0.0 --port 39722 --reload
    ```
 
 ### **코드 컨벤션 (PEP 8, Ruff, Black)**
@@ -141,24 +141,23 @@
 
 1. **브라우저 확인**
 
-   - 기본 루트 엔드포인트: <http://localhost:8000/>
-   - 헬스 체크 엔드포인트: <http://127.0.0.1:8000/health>
-   - API 문서: <http://127.0.0.1:8000/docs>
+   - 기본 루트 엔드포인트: <http://localhost:39722/>
+   - 헬스 체크 엔드포인트: <http://127.0.0.1:39722/health>
+   - API 문서: <http://127.0.0.1:39722/docs>
 
 2. **CLI로 접속 확인하기**
 
    FastAPI 앱이 poetry run uvicorn main:app --reload 명령어로 실행 중인 상태에서, 새로운 터미널을 열고 다음 curl 명령어를 입력하여 각 엔드포인트의 응답을 확인할 수 있습니다.
 
    - 기본 루트 엔드포인트:
      ```bash
-     curl http://localhost:8000/
+     curl http://localhost:39722/
      ```
    - 헬스 체크 엔드포인트:
      ```bash
-     curl http://localhost:8000/health
+     curl http://localhost:39722/health
      ```
    - API 문서:
      ```bash
-     curl http://localhost:8000/openapi.json
+     curl http://localhost:39722/openapi.json
      ```
-

app/api/annotation_api.py

@@ -0,0 +1,75 @@
+from fastapi import APIRouter, Depends
+
+from app.core.response import ResponseMessage
+from app.core.status import CommonCode
+from app.schemas.annotation.request_model import AnnotationCreateRequest
+from app.schemas.annotation.response_model import AnnotationDeleteResponse, FullAnnotationResponse
+from app.services.annotation_service import AnnotationService, annotation_service
+
+annotation_service_dependency = Depends(lambda: annotation_service)
+
+router = APIRouter()
+
+
+@router.post(
+    "/create",
+    response_model=ResponseMessage[FullAnnotationResponse],
+    summary="새로운 어노테이션 생성",
+)
+async def create_annotation(
+    request: AnnotationCreateRequest,
+    service: AnnotationService = annotation_service_dependency,
+) -> ResponseMessage[FullAnnotationResponse]:
+    """
+    `db_profile_id`를 받아 AI를 통해 DB 스키마를 분석하고 어노테이션을 생성하여 반환합니다.
+    """
+    new_annotation = await service.create_annotation(request)
+    return ResponseMessage.success(value=new_annotation, code=CommonCode.SUCCESS_CREATE_ANNOTATION)
+
+
+@router.get(
+    "/find/{annotation_id}",
+    response_model=ResponseMessage[FullAnnotationResponse],
+    summary="특정 어노테이션 상세 정보 조회",
+)
+def get_annotation(
+    annotation_id: str,
+    service: AnnotationService = annotation_service_dependency,
+) -> ResponseMessage[FullAnnotationResponse]:
+    """
+    `annotation_id`에 해당하는 어노테이션의 전체 상세 정보를 조회합니다.
+    """
+    annotation = service.get_full_annotation(annotation_id)
+    return ResponseMessage.success(value=annotation, code=CommonCode.SUCCESS_FIND_ANNOTATION)
+
+
+@router.get(
+    "/find/db/{db_profile_id}",
+    response_model=ResponseMessage[FullAnnotationResponse],
+    summary="DB 프로필 ID로 어노테이션 조회",
+)
+def get_annotation_by_db_profile_id(
+    db_profile_id: str,
+    service: AnnotationService = annotation_service_dependency,
+) -> ResponseMessage[FullAnnotationResponse]:
+    """
+    `db_profile_id`에 연결된 어노테이션의 전체 상세 정보를 조회합니다.
+    """
+    annotation = service.get_annotation_by_db_profile_id(db_profile_id)
+    return ResponseMessage.success(value=annotation, code=CommonCode.SUCCESS_FIND_ANNOTATION)
+
+
+@router.delete(
+    "/remove/{annotation_id}",
+    response_model=ResponseMessage[AnnotationDeleteResponse],
+    summary="특정 어노테이션 삭제",
+)
+def delete_annotation(
+    annotation_id: str,
+    service: AnnotationService = annotation_service_dependency,
+) -> ResponseMessage[AnnotationDeleteResponse]:
+    """
+    `annotation_id`에 해당하는 어노테이션 및 하위 데이터를 모두 삭제합니다.
+    """
+    result = service.delete_annotation(annotation_id)
+    return ResponseMessage.success(value=result, code=CommonCode.SUCCESS_DELETE_ANNOTATION)