Files
TK-BOM-Project/IMPROVEMENTS.md

1.3 KiB

TK-MP-Project Backend 개선/확장/운영 권장사항

1. 코드 구조/품질

  • ResponseModel(Pydantic) 적용: API 반환값의 타입 안정성 및 문서화 강화
  • 로깅/에러 처리: print → logging 모듈, 운영 환경에 맞는 에러/이벤트 기록
  • 환경변수/설정 분리: CORS, DB, 포트 등 환경별 관리 용이하게 분리
  • 라우터 자동 등록/동적 관리: 라우터가 많아질 경우 코드 중복 최소화

2. 보안/운영

  • CORS 제한: 운영 환경에서는 허용 origin을 제한
  • 업로드 파일 검증 강화: 경로, 파일명, 크기 등 보안 검증 추가

3. 성능/확장성

  • 대용량 파일/데이터 처리: 비동기/청크 처리, 인덱스 튜닝 등
  • DB 트랜잭션 명확화: 파일/자재 저장 등에서 트랜잭션 관리 강화

4. 테스트/CI

  • 자동화 테스트(assert 기반): print 위주 → assert 기반 자동화로 CI/CD 연동
  • 테스트 커버리지 확대: 다양한 예외/경계 케이스 추가

5. 기타

  • 코드/유틸 함수 분리: 중복 유틸 함수는 별도 모듈로 분리
  • 상태/활성화 관리 enum화: status 등은 enum으로 관리
  • 삭제/수정 API 추가: Job 등 주요 엔티티의 논리적 삭제/수정 지원

2024-07-15 기준, backend 코드 리뷰 기반 개선/확장/운영 권장사항 정리