교보DTS-Cloud architecture DX Academy(CDA) 최종 프로젝트 Backend 저장소
E-book 서비스를 운영하는 고객사의 요구사항에 따라 AWS 아키텍처를 구성 및 이에 따라 기존 Back-end code가 정리되어있는 refraction임.
kyoboDTS-CDA1-5L3T
├── Dockerfile
├── Lambda_S3
│ ├── README.MD
│ ├── admin_delete_general_book.py
│ ├── admin_delete_serial_novel.py
│ ├── admin_register_general_book.py
│ ├── admin_register_serial_novel.py
│ └── admin_search_ebook.py
├── README.md
├── S3-RDS-Lambda(4종)
│ ├── EDIT_books.py
│ ├── EDIT_series.py
│ ├── PUT_books.py
│ ├── PUT_series.py
│ ├── README.MD
│ ├── [함수개요]datasync_general_book.MD
│ ├── [함수개요] datasync_S3toRDS_updates.MD
│ ├── [함수개요]datasync_S3toRDS_generalbooks.MD
│ └── [함수개요]datasync_serial_novels.MD
├── app
│ ├── __init__.py
│ ├── api
│ │ ├── __init__.py
│ │ ├── general_book_read.py
│ │ ├── general_book_search.py
│ │ ├── list_ebook.py
│ │ ├── search_ebooks.py
│ │ ├── serial_novel_read.py
│ │ └── serial_novel_search.py
│ ├── core
│ │ ├── config.py
│ │ ├── rds_config.py
│ │ └── s3_config.py
│ ├── data
│ │ ├── README.MD
│ │ └── metadata.json
│ ├── main.py
│ └── schema
│ └── mysql_schema.py
├── data
│ ├── README.MD
│ └── metadata.json
├── pytest.ini
├── requirements.txt
└── tests
└── api
├── test_general_book_read.py
├── test_general_book_search.py
├── test_list_ebooks.py
├── test_search_ebooks.py
├── test_serial_novel_read.py
└── test_serial_novel_search.py
프로젝트의 루트 디렉토리로, 프로젝트 설정 파일 및 주요 문서가 포함됨.
.dockerignore: Docker 이미지 빌드시 제외할 파일 정의.gitignore: Git에서 무시할 파일 및 디렉토리 지정Dockerfile: Docker 이미지를 생성하기 위한 설정 파일README.md: 프로젝트 개요와 설명을 담은 문서requirements.txt: 프로젝트에 필요한 라이브러리 리스트
주요 애플리케이션 디렉토리로, 핵심 API 구성 요소와 설정 파일이 포함됩니다.
eBook 서비스와 관련된 각 API 모듈이 포함된 디렉토리입니다.
__init__.py:api패키지를 초기화하여 모듈을 애플리케이션 전반에서 가져올 수 있도록 설정general_book_search.py: 일반 도서 검색 API 엔드포인트를 정의general_book_read.py: 일반 도서 열람 API 엔드포인트를 정의serial_novel_search.py: 연재 소설 검색 API 엔드포인트를 정의serial_novel_read.py: 연재 소설 열람 API 엔드포인트를 정의
애플리케이션의 주요 설정 및 환경 구성이 포함된 디렉토리입니다.
config.py: AWS 및 프로젝트 환경 변수, 데이터베이스 설정, API 키와 같은 애플리케이션 설정을 정의
FastAPI 애플리케이션의 진입점으로, 앱을 초기화하고 api 모듈의 라우터를 등록하여 애플리케이션을 실행하는 파일.
테스트 파일을 저장하기에 적합한 디렉토리입니다. 테스트 코드는 /app/api 디렉토리 구조에 맞춰서 배치하면 관리에 용이함.
- 테스트 파일 예시:
/tests/api/test_general_book_search.py/tests/api/test_general_book_read.py/tests/api/test_serial_novel_search.py/tests/api/test_serial_novel_read.py
- 디렉토리 위치:
Lambda_S3/
-
admin_delete_general_book.py- 역할: S3에서 일반 도서 데이터 파일이 삭제될 때 RDS에서 해당 메타데이터를 삭제.
- 트리거: S3 DELETE 이벤트.
-
admin_register_general_book.py- 역할: 일반 도서 데이터 파일 또는 메타데이터 파일이 S3에 업로드되거나 수정될 경우, 이를 RDS 메타데이터에 추가 또는 업데이트.
- 트리거: S3 PUT/EDIT 이벤트.
-
admin_delete_serial_novel.py- 역할: S3에서 연재 소설의 메타데이터 파일이 삭제되면, 이를 RDS 메타데이터에서 삭제.
- 트리거: S3 DELETE 이벤트.
-
admin_register_serial_novel.py- 역할: 연재 소설의 메타데이터 또는 관련 데이터 파일이 S3에 업로드되거나 수정될 경우, 이를 RDS 메타데이터에 등록 또는 업데이트.
- 트리거: S3 PUT/EDIT 이벤트.
- FastAPI: Back-end 핵심 웹 프레임워크로, 빠르고 효율적인 API 구축 지원
- Uvicorn: FastAPI 애플리케이션을 ASGI 서버로 실행하기 위한 ASGI server
- pytest: 테스트 작성 및 실행을 위한 프레임워크
pip install -r requirements.txtFastAPI 애플리케이션을 실행하려면, 프로젝트의 루트 디렉토리에서 다음 명령어를 사용:
uvicorn app.main:app --reload현재 테스트 명령어 및 파일은 /tests 디렉토리 내에서 실행할 수 있도록 구성되어 있음.
- 경로:
/general_book/search - 메서드:
GET - 파일위치:
/app/api/general_book_search.py - 설명: 제목, 저자 등을 기준으로 일반 도서 eBook을 검색.
- 요청 파라미터:
query(string, 필수): 검색어page(integer, 선택): 페이지 번호, 기본값은 1
- 응답:
- 200 OK: 검색된 도서 목록 (책 ID, 제목, 저자, 요약 등 포함)
- 경로:
/general_book/read/{book_id} - 메서드:
POST - 파일위치:
/app/api/general_book_read.py - 설명: 특정 도서 ID에 해당하는 일반 도서 eBook을 열람합니다.
- 요청 경로 변수:
book_id(integer, 필수): 열람할 도서의 ID
- 응답:
- 200 OK: 도서의 상세 정보 및 본문 내용
- 404 Not Found: 해당 ID의 도서가 존재하지 않을 때 반환
- 경로:
/serial_novel/search - 메서드:
GET - 파일위치:
/app/api/serial_novel_search.py - 설명: 제목, 저자 등을 기준으로 연재 소설 eBook을 검색.
- 요청 파라미터:
query(string, 필수): 검색어page(integer, 선택): 페이지 번호, 기본값은 1
- 응답:
- 200 OK: 검색된 연재 소설 목록 (소설 ID, 제목, 작가, 요약 등 포함)
- 경로:
/serial-novels/read/{book_id} - 메서드:
POST - 파일위치:
/app/api/serial_novel_read.py - 설명: 특정 연재 소설 ID에 해당하는 eBook을 열람합니다.
- 요청 경로 변수:
novel_id(integer, 필수): 열람할 소설의 ID
- 응답:
- 200 OK: 소설의 상세 정보 및 본문 내용
- 404 Not Found: 해당 ID의 소설이 존재하지 않을 때 반환