ApiHelper
@churchapps/apihelper 패키지는 모든 ChurchApps Express.js API를 위한 서버 측 유틸리티를 제공합니다. 기본 컨트롤러 클래스, JWT 인증 미들웨어, 데이터베이스 유틸리티, AWS 통합을 포함하며 모든 API 프로젝트가 의존합니다.
시작하기 전에
- Node.js 및 Git 설치 -- 필수 조건 참조
- 로컬 개발을 위한 npm link 워크플로우 숙지
- 이 패키지는
@churchapps/helpers에 의존합니다
포함 내용
- CustomBaseController -- API 컨트롤러의 기본 클래스
- 인증 미들웨어 --
CustomAuthProvider를 통한 JWT 인증 - 데이터베이스 유틸리티 -- MySQL 연결 관리를 위한
DB.query,EnhancedPoolHelper - AWS 통합 -- S3, SSM 매개변수 저장소, 기타 AWS 서비스용 헬퍼
- Inversify DI 설정 -- 의존성 주입 컨테이너 구성
로컬 개발을 위한 설정
-
저장소 복제:
git clone https://github.com/ChurchApps/ApiHelper.git -
의존성 설치:
cd ApiHelper && npm install -
패키지 빌드 (TypeScript를
dist/로 컴파일):npm run build -
로컬 링킹 가능하게 만들기:
npm link
주요 명령
| 명령 | 설명 |
|---|---|
npm run build | TypeScript를 dist/로 컴파일 |
npm run lint | ESLint 실행 |
npm run lint:fix | 자동 수정과 함께 ESLint 실행 |
npm run format | Prettier로 코드 포맷 |
정보
이 패키지는 모든 ChurchApps API의 의존성입니다. 변경을 한 후 게시하기 전에 npm link를 사용하여 API에 대해 테스트하세요.