v0.1.0, ChatBot_Docker

[CutTheWire]

FastAPI 프로젝트 구조 설명

이 프로젝트는 FastAPI를 사용하여 다양한 기능을 제공하는 웹 애플리케이션을 개발한 예입니다. 주로 MongoDB와 MySQL 데이터베이스를 사용하여 데이터 처리를 수행하며, 각 기능은 라우터로 구분되어 있습니다.

디렉터리 및 파일 설명

• 📂 .pytest_cache: pytest를 사용하여 테스트할 때 생성되는 캐시 파일들이 위치한 폴더입니다.
• 📂 batchfile: 가상 환경 설정과 관련된 배치 파일이 포함된 폴더입니다.
  • venv_install.bat: 가상 환경 설치를 위한 배치 파일.
  • venv_setup.bat: 가상 환경 설정을 위한 배치 파일.
• 📂 sources: FastAPI 애플리케이션의 소스 코드와 관련 파일들이 포함된 폴더입니다.
  • 📂 logs: 애플리케이션 실행 중 발생한 오류 로그 파일(error.log)이 포함된 폴더입니다.
  • 📂 utils: 유틸리티 모듈들이 포함된 폴더입니다. 여기에는 데이터베이스 핸들러와 에러 핸들러가 포함되어 있습니다.
    • DB_mongo.py: MongoDB와 상호작용하는 핸들러 클래스가 정의된 모듈.
    • DB_mysql.py: MySQL과 상호작용하는 핸들러 클래스가 정의된 모듈.
    • Error_handlers.py: 애플리케이션 전반에서 사용되는 예외 처리를 정의한 모듈.
    • Models.py: 데이터베이스 모델 및 데이터 검증을 위한 Pydantic 모델이 정의된 모듈.
  • server.py: FastAPI 애플리케이션의 메인 서버 파일로, 모든 라우터와 미들웨어 설정이 정의되어 있습니다.
  • .env: 환경 변수 설정 파일로, 데이터베이스 접속 정보와 같은 민감한 정보들이 포함됩니다.
• 📜 Dockerfile: 애플리케이션을 Docker 컨테이너로 배포하기 위한 설정 파일입니다.
• 📜 requirements.txt: 애플리케이션에서 사용하는 Python 패키지와 그 버전 정보가 나열된 파일입니다.
• 📜 [wait-for-it.sh](http://wait-for-it.sh/): 서비스가 시작될 때까지 대기하는 스크립트로, Docker 환경에서 주로 사용됩니다.

주요 코드 설명 (server.py)

• 애플리케이션 초기화:
  • FastAPI 객체를 생성하면서 lifespan을 사용해 애플리케이션의 수명 주기를 관리합니다.
  • 예외 처리 미들웨어, 세션 미들웨어, CORS 미들웨어 등이 설정되어 있습니다.
• 커스텀 OpenAPI 설정:
  • custom_openapi() 함수를 사용하여 OpenAPI 문서에 대한 커스터마이징을 수행합니다.
• 라우터 설정:
  • MySQL 라우터: /mysql 경로 하위에 MySQL 관련 기능을 제공합니다.
  • MongoDB 라우터: /mongo 경로 하위에 MongoDB 관련 기능을 제공합니다.
• 미들웨어 설정:
  • 모든 HTTP 요청에 대해 예외를 처리하는 미들웨어가 정의되어 있습니다.

데이터베이스 핸들러 설명 (DB_mongo.py, DB_mysql.py)

• MongoDBHandler:
  • MongoDB와 연결하고 데이터베이스 및 컬렉션에 대해 CRUD 작업을 수행하는 메서드를 제공합니다.
  • create_chatlog_collection, add_chatlog_value, get_chatlog_value, remove_chatlog_value 등의 메서드가 포함되어 있습니다.
• MySQLDBHandler:
  • MySQL 데이터베이스와의 연결을 관리하며, 쿼리 실행 및 데이터베이스 작업을 수행하는 메서드를 제공합니다.

API 명세서를 포함한 FastAPI 프로젝트 구조와 주요 엔드포인트에 대한 설명을 추가하겠습니다.

프로젝트 구조

📦fastapi
 ┣ 📂batchfile
 ┃ ┣ 📜venv_install.bat
 ┃ ┗ 📜venv_setup.bat
 ┣ 📂sources
 ┃ ┣ 📂utils
 ┃ ┃ ┣ 📜DB_mongo.py
 ┃ ┃ ┣ 📜DB_mysql.py
 ┃ ┃ ┣ 📜Error_handlers.py
 ┃ ┃ ┗ 📜Models.py
 ┃ ┣ 📜.env
 ┃ ┗ 📜server.py
 ┣ 📜.DS_Store
 ┣ 📜Dockerfile
 ┣ 📜requirements.txt
 ┗ 📜wait-for-it.sh

API 명세서

API 명세서는 프로젝트의 주요 엔드포인트와 그 기능에 대한 설명을 포함합니다.

기본 정보

• 제목: ChatBot FastAPI
• 버전: v0.1.0-dev
• 설명: 이 API는 유저 채팅 문서의 생성, 저장, 조회 및 삭제 등의 기능을 제공합니다.

엔드포인트

각 엔드포인트는 MySQL과 MongoDB 관련 작업을 다룹니다.

MySQL 관련 엔드포인트

메소드	경로	설명
GET	/mysql/tables	MySQL 데이터베이스 내의 모든 테이블 목록을 반환합니다.
GET	/mysql/query	사용자 정의 MySQL 쿼리를 실행하고 결과를 반환합니다.

예시

• 테이블 목록 가져오기

  • 엔드포인트: GET /mysql/tables
  • 설명: MySQL 데이터베이스 내의 모든 테이블 목록을 반환합니다.

  • 응답:

    {
      "Tables": ["users", "orders", "products"]
    }
    

• 사용자 정의 쿼리 실행

  • 엔드포인트: GET /mysql/query
  • 설명: 사용자 정의 MySQL 쿼리를 실행하고 결과를 반환합니다.

  • 응답:

    {
      "Result": [
        {"id": 1, "name": "John Doe"},
        {"id": 2, "name": "Jane Doe"}
      ]
    }
    

MongoDB 관련 엔드포인트

메소드	경로	설명
GET	/mongo/db	MongoDB 서버에 있는 데이터베이스 목록을 조회합니다.
GET	/mongo/collections	현재 데이터베이스의 컬렉션 목록을 조회합니다.
POST	/mongo/chat/create	MongoDB에 새로운 유저 채팅 문서(채팅 로그)를 생성합니다.
PUT	/mongo/chat/save_log	생성된 채팅 문서에 유저의 채팅 데이터를 저장합니다.
POST	/mongo/chat/load_log	생성된 채팅 문서의 채팅 로그를 MongoDB에서 불러옵니다.
DELETE	/mongo/chat/delete_log	최신 대화 ~ 선택된 채팅을 로그에서 삭제합니다.

예시

• 데이터베이스 목록 가져오기

  • 엔드포인트: GET /mongo/db
  • 설명: MongoDB 서버에 있는 모든 데이터베이스의 목록을 반환합니다.

  • 응답:

    {
      "Database": ["db1", "db2", "db3"]
    }
    

• 데이터베이스 컬렉션 목록 조회

  • 엔드포인트: GET /mongo/collections
  • 설명: 선택한 데이터베이스 내의 모든 컬렉션 이름을 반환합니다.

  • 응답:

    {
      "Collections": ["collection1", "collection2", "collection3"]
    }
    

• 유저 채팅방 ID 생성

  • 엔드포인트: POST /mongo/chat/create

  • 설명: 새로운 유저 채팅 문서(채팅 로그)를 MongoDB에 생성합니다.

  • 요청 본문:

    {
      "user_id": "shaa97102"
    }
    

  • 응답:

    {
      "Document ID": "123e4567-e89b-12d3-a456-426614174000"
    }
    

• 유저 채팅 저장

  • 엔드포인트: PUT /mongo/chat/save_log

  • 설명: 생성된 채팅 문서에 유저의 채팅 데이터를 저장합니다.

  • 요청 본문:

    {
        "user_id": "shaa97102",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "img_url": "<https://drive.google.com/thumbnail?id=12PqUS6bj4eAO_fLDaWQmoq94-771xfim>",
        "input_data": "안녕하세요, 챗봇!",
        "output_data": "안녕하세요! 무엇을 도와드릴까요?"
    }
    

  • 응답:

    {
        "Result": "Successfully added data to document with ID: 123e4567-e89b-12d3-a456-426614174000"
    }
    

• 유저 채팅 불러오기

  • 엔드포인트: POST /mongo/chat/load_log

  • 설명: 생성된 채팅 문서의 채팅 로그를 MongoDB에서 불러옵니다.

  • 요청 본문:

    {
        "user_id": "shaa97102",
        "id": "123e4567-e89b-12d3-a456-426614174000"
    }
    

  • 응답:

    {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "value": [
            {
            "index": 1,
            "img_url": "<https://drive.google.com/thumbnail?id=12PqUS6bj4eAO_fLDaWQmoq94-771xfim>",
            "input_data": "안녕하세요, 챗봇!",
            "output_data": "안녕하세요! 무엇을 도와드릴까요?"
            }
        ]
    }
    

• 유저 채팅 일부 지우기

  • 엔드포인트: DELETE /mongo/chat/delete_log

  • 설명: 최신 대화 ~ 선택된 채팅을 로그에서 삭제합니다.

  • 요청 본문:

    {
      "user_id": "user123",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "index": 1
    }
    

  • 응답:

    {
      "Result": "Successfully removed data from index: 1 to the end in document with ID: 123e4567-e89b-12d3-a456-426614174000"
    }
    

헬스 체크 엔드포인트

메소드	경로	설명
GET	/	서버의 상태를 확인합니다.

• 헬스 체크

  • 엔드포인트: GET /
  • 설명: 서버의 상태를 확인하는 헬스 체크 엔드포인트입니다.

  • 응답:

    {
      "Connection": "Success"
    }