0.1.0 • Published 4 years ago
bo-api-starter v0.1.0
bo-api-starter
:smiley: 블록오디세이에 맞춘 Express Api Starter입니다. :smiley: :bangbang: 프로젝트 설치 방법 & 사용 설명서 :bangbang:
Project Features
- Server : Express
- Database : MySQL
- Authentication : jsonwebtoken
- URL + Responses : node-fetch
- AWS SDK : aws-sdk
- Environment Variables : dotenv
Project Installation
:fire: npm i bo-api-starter 명령어를 사용하면 프로젝트가 정상적으로 설치되지 않습니다. :fire:
Usage and Getting Started
Project Environment Setup
1. .env.example 파일을 복사하여 .env 파일을 생성
2. config.js 파일에서 .env 파일의 경로를 수정
Package Install
Project Run
HTTP Respose 작성 예시
1. 결과 메시지 가져오기
결과 메시지는 다음과 같은 형태로 되어 있습니다.
(모든 메시지 종류는 common/statusMessages.js 파일을 참조하세요.)
Business Logic에서 다음 예시와 같이 사용합니다.
2. HTTP 상태 코드 가져오기
router에서 다음 예시와 같이 사용합니다.
Project Flow
| 순서 | 파일 / 폴더 | 기능 |
|---|---|---|
| 1 | app.js | middleware 추가, route 추가 |
| 2 | middleware | middleware 설정 |
| 3 | routes | router(request, response) 작성 |
| 4 | service | Business Logic 작성 |
| 5 | query | SQL Query 작성 |
Project Structure
.
├── README.MD
├── app.js
├── bin # 실행 파일
│ └── www
├── common # 공용 파일
│ └── common.js # 공용 함수
│ └── getStatus.js # HTTP 상태 코드 처리
│ └── statusMessages.js # HTTP 응답 메시지
├── config.js # MySQL, AWS, 환경변수 등 설정
├── ecosystem.config.js # PM2 환경 설정
├── middleware # MIDDLEWARE 설정
│ ├── adminMW.js # ADMIN
│ ├── appMw.js # APP
│ └── webMW.js # WEB
├── package.json
├── query # SQL Query
│ └── users.js
├── routes
│ ├── admin # ADMIN
│ │ ├── index.js
│ │ └── users.js
│ ├── app # APP
│ │ ├── index.js
│ │ └── users.js
│ └── web # WEB
│ ├── index.js
│ └── users.js
└── service # Business Logic
│ └── users.js
└── views
└── error.ejs
└── index.ejs
└── style.css