- FastAPI ๊ฐ๋ฐ ์๋ฒ ์คํ ๋ช ๋ น์ด
$ gunicorn -w 4 -k uvicorn.workers.UvicornWorker src.main:app
- ํ๋ก์ ํธ ์ด๋ฆ: Micgolf ์ผํ๋ชฐ ์ ์
- ํ๋ก์ ํธ ์ค๋ช : ๊ณจํ ๋ธ๋๋ '๋ฏน๊ณจํ(Micgolf)' ํํ์ด์ง ์ ๊ท ๊ฐ๋ฐ
| ์์ฐ์ง | ๊ฐ์น์ง | ๊นํ์ฐ | ์ ๋ฏผ์ค |
|---|---|---|---|
| BE | BE | BE | BE |
| GitHub | GitHub | GitHub | GitHub |
-
ํ์๊ฐ์ :
- ์์ฒด ํ์๊ฐ์ ๋ฐ ์์ (Naver, Kakao) ๋ก๊ทธ์ธ ๊ตฌํ
-
์ํ ๊ด๋ฆฌ:
- ์ํ ๋ฑ๋ก, ์์ , ์ญ์ , ์กฐํ ๋ฑ
-
ํ๋ก๋ชจ์ ๊ด๋ฆฌ:
- "Best Choice", "Md's pick" ๋ฑ ํ๋ก๋ชจ์ ๋ฑ๋ก, ์กฐํ, ์์ , ์ญ์ ๊ธฐ๋ฅ
-
๋ฐฐ๋, ์นดํ ๊ณ ๋ฆฌ ๊ด๋ฆฌ:
- ๋ฉ์ธ ํ์ด์ง์ ๋ฐฐ๋, ์นดํ ๊ณ ๋ฆฌ ๊ด๋ฆฌ (๋ฑ๋ก, ์์ , ์ญ์ ๊ธฐ๋ฅ)
-
์ฅ๋ฐ๊ตฌ๋ ๊ด๋ฆฌ:
- (ํ์)์ฅ๋ฐ๊ตฌ๋ ๊ธฐ๋ฅ
-
์ฃผ๋ฌธ ๋ฐ ๊ฒฐ์ :
- ํ์/๋นํ์์ ์ฃผ๋ฌธ ๋ฐ ๊ฒฐ์ ์ฒ๋ฆฌ ๊ธฐ๋ฅ
| ์ด๋ฆ | ์ญํ | ๊ฐ๋ฐ ์์ |
|---|---|---|
| ์์ฐ์ง | ํ์ฅ | * ์๋ฒ ๊ตฌ์ถ ๋ฐ ์ด์ฉ * ํ๋ก๋ชจ์ ๊ธฐ๋ฅ ๊ฐ๋ฐ * ์ฅ๋ฐ๊ตฌ๋ ๊ธฐ๋ฅ ๊ฐ๋ฐ |
| ๊นํ์ฐ | ํ์ | * ์ปค๋ฎค๋์ผ์ด์
(๊ธฐ์
๋ฐ FE) * ํ์๊ฐ์ / ๋ก๊ทธ์ธ ๊ธฐ๋ฅ ๊ฐ๋ฐ * ๊ฒฐ์ ๊ธฐ๋ฅ ๊ฐ๋ฐ * ์ํ ๊ด๋ฆฌ ๊ธฐ๋ฅ ๊ฐ๋ฐ |
| ๊ฐ์น์ง | ํ์ | * ๋ฐฐ๋ ๊ธฐ๋ฅ ๊ฐ๋ฐ * ๊ฒฐ์ ๊ธฐ๋ฅ ๊ฐ๋ฐ |
| ์ ๋ฏผ์ค | ํ์ | * ์นดํ
๊ณ ๋ฆฌ ๊ธฐ๋ฅ ๊ฐ๋ฐ *์ฃผ๋ฌธ ๊ธฐ๋ฅ ๊ฐ๋ฐ *๊ฒฐ์ ๊ธฐ๋ฅ ๊ฐ๋ฐ |
| ํญ๋ชฉ | ๊ธฐ์ | ์ค๋ช |
|---|---|---|
| ํ๋ก๊ทธ๋๋ฐ ์ธ์ด | Python | Python ๊ธฐ๋ฐ์ ์ ํ๋ฆฌ์ผ์ด์ ๊ฐ๋ฐ |
| ์น ํ๋ ์์ํฌ | FastAPI | Python ๊ธฐ๋ฐ์ ํ๋์ ์ด๊ณ ๋น ๋ฅธ ์น ํ๋ ์์ํฌ |
| ๋ฐ์ดํฐ๋ฒ ์ด์ค | MySQL | DB for MySQL (NCP) ์๋น์ค๋ฅผ ์ด์ฉํ์ฌ ๋ฐ์ดํฐ๋ฒ ์ด์ค ์คํ ์ค |
| ORM | Tortoise-ORM | Python ORM ๋ผ์ด๋ธ๋ฌ๋ฆฌ๋ก, ๋ฐ์ดํฐ๋ฒ ์ด์ค ์์ ์ ์ฒ๋ฆฌ |
| ๊ฒฐ์ ์์คํ | PortOne(ํฌํธ์) | ๊ฒฐ์ ์ฒ๋ฆฌ ๋ฐ ๊ด๋ จ ์๋น์ค ์ฐ๋ |
| Redis | Redis | ๋ฐ์ดํฐ ์บ์ฑ ๋ฐ ์ธ์ ๊ด๋ฆฌ์ฉ์ผ๋ก ์ฌ์ฉ |
| ์น ์๋ฒ | Apache2 | FastAPI ์ ํ๋ฆฌ์ผ์ด์ ์ ๋ฐฐํฌํ๊ธฐ ์ํ ์น ์๋ฒ |
| ๋ณด์ | SSL/TLS ์ธ์ฆ์ | HTTPS๋ฅผ ์ง์ํ๊ธฐ ์ํด NCP ๋ก๋ ๋ฐธ๋ฐ์์ SSL ์ธ์ฆ์ ๋ฑ๋ก |
| ๋ฐฐํฌ ํ๊ฒฝ | Naver Cloud Platform (NCP) | ์๋ฒ ํธ์คํ ๋ฐ ์ด์ |
| JWT ์ธ์ฆ | JWT (Json Web Token) | OAuth๋ฅผ ํตํด ์ธ์ฆ๋ ์ฌ์ฉ์์๊ฒ JWT ํ ํฐ์ ๋ฐ๊ธ |
| ์ฝ๋ ํ์ง ๊ฒ์ฌ | * MyPy * isort * black |
* Python ์ฝ๋์ ์ ์ ํ์
๊ฒ์ฌ * import ์ ๋ ฌ ํ์ธ * ์ฝ๋ ์คํ์ผ ํ์ธ |
| ํ ์คํธ ํ๋ ์์ํฌ | pytest | FastAPI ์ ํ๋ฆฌ์ผ์ด์ ์ ์ ๋ ํ ์คํธ์ ํตํฉ ํ ์คํธ๋ฅผ ์คํ |
| ์๋น์ค ์ข ๋ฅ | ์๋น์ค ์ด๋ฆ | ์ค๋ช |
|---|---|---|
| ์๋ฒ | Server (VPC) | ๊ฐ์ ์ฌ์ค ํด๋ผ์ฐ๋ ํ๊ฒฝ์์ ์๋ฒ ์ธ์คํด์ค๋ฅผ ์์ฑ ๋ฐ ๊ด๋ฆฌ. |
| ๋ฐ์ดํฐ๋ฒ ์ด์ค | DB for MySQL | MySQL ๊ธฐ๋ฐ์ ๋ฐ์ดํฐ๋ฒ ์ด์ค ๊ด๋ฆฌ ์๋น์ค. |
| ๋ก๋ ๋ฐธ๋ฐ์ฑ | Load Balancer | ๋คํธ์ํฌ ํธ๋ํฝ์ ์ฌ๋ฌ ์๋ฒ๋ก ๋ถ์ฐํ์ฌ ๊ณ ๊ฐ์ฉ์ฑ์ ์ ๊ณต. |
| ์คํ ๋ฆฌ์ง | Block Storage | ์๋ฒ์ ์ฐ๊ฒฐ๋ ๊ณ ์ ์ ์ฅ ์ฅ์น. |
| DNS ๊ด๋ฆฌ | Global DNS | ์ ์ธ๊ณ์ ๊ฑธ์ณ DNS ์ค์ ์ ๊ด๋ฆฌํ๊ณ ๊ณ ์ ์๋ต ์ ๊ณต. |
| ๋คํธ์ํฌ | Network | VPC, ์๋ธ๋ท, ๋ฐฉํ๋ฒฝ ๋ฑ ๋คํธ์ํฌ ๋ฆฌ์์ค๋ฅผ ๊ตฌ์ฑ ๋ฐ ๊ด๋ฆฌ. |
| ์ค๋ธ์ ํธ ์คํ ๋ฆฌ์ง | Object Storage | ๋๋์ ๋น์ ํ ๋ฐ์ดํฐ๋ฅผ ์ ์ฅํ ์ ์๋ ์คํ ๋ฆฌ์ง ์๋น์ค. |
| ๊ณต์ธ IP | Public IP | ์ธํฐ๋ท์์ ์ ๊ทผ ๊ฐ๋ฅํ ๊ณต์ธ IP ์ฃผ์ ์ ๊ณต. |
backend/
โโโ src/
โ โโโ app/
โ โ โโโ banner/
โ โ โ โโโ dtos/
โ โ โ โโโ models/
โ โ โ โโโ services/
โ โ โ โโโ __init__.py
โ โ โ โโโ router.py
โ โ โโโ cart/
โ โ โโโ category/
โ โ โโโ order/
โ โ โโโ payment/
โ โ โโโ product/
โ โ โโโ promotion_product/
โ โ โโโ user/
โ โโโ common/
โ โ โโโ constants/
โ โ โโโ exceptions/
โ โ โโโ github_webhook/
โ โ โโโ handlers/
โ โ โโโ middlewares/
โ โ โโโ models/
โ โ โ โโโ base_model.py
โ โ โโโ utils/
โ โ โโโ __init__.py
โ โ โโโ post_construct.py
โ โโโ core/
โ โ โโโ configs/
โ โ โ โโโ __init__.py
โ โ โ โโโ settings.py
โ โ โโโ database/
โ โ โ โโโ db_settings.py
โ โ โ โโโ models.py
โ โ โโโ __init__.py
โ โโโ tests/
โ โโโ .env # ํ๊ฒฝ ๋ณ์ ํ์ผ
โ โโโ conftest.py
โ โโโ main.py
โ โโโ poetry.lock
โ โโโ pyproject.toml
โ โโโ start_gunicorn.sh # ์๋ฒ ์คํ ์คํฌ๋ฆฝํธ
โ โโโ test.sh
โโโ .gitignore
โโโ docker-compose.yml
โโโ docker-compose-mysql.yml
โโโ Dockerfile
โโโ README.md
์ฐ๋ฆฌ์ ๋ธ๋์น ์ ๋ต์ Git Flow๋ฅผ ๊ธฐ๋ฐ์ผ๋ก ํ๋ฉฐ, ๋ค์๊ณผ ๊ฐ์ ๋ธ๋์น๋ฅผ ์ฌ์ฉํฉ๋๋ค:
-
develop ๋ธ๋์น
- ๋ฐฐํฌ ๊ฐ๋ฅํ ์์ ์ ์ธ ์ฝ๋๋ฅผ ์ ์งํฉ๋๋ค.
- ๋ชจ๋ ๋ฐฐํฌ๋ ์ด ๋ธ๋์น์์ ์ด๋ฃจ์ด์ง๋๋ค.
-
Feature ๋ธ๋์น
- ๊ฐ ๊ธฐ๋ฅ ๊ฐ๋ฐ์ ์ํ ๋ธ๋์น์ ๋๋ค.
- feature/{๊ธฐ๋ฅ๋ช } ํ์์ผ๋ก ๋ธ๋์น๋ฅผ ์์ฑํฉ๋๋ค.
- ๊ธฐ๋ฅ ๊ฐ๋ฐ ์๋ฃ ํ develop ๋ธ๋์น๋ก ๋ณํฉํฉ๋๋ค.
์๋ Gitmoji ๊ท์น์ ์ฐธ๊ณ ํ์ฌ ์ปค๋ฐ ๋ฉ์ธ์ง ํ ํ๋ฆฟ์ ์์ฑํจ
- โจ feat: ์๋ก์ด ๊ธฐ๋ฅ ์ถ๊ฐ
- ๐ fix: ๊ธฐ๋ฅ ์์ , ๋ฒ๊ทธ ์์
- ๐ก chore: ์คํ ์์ ๋ฐ ์๋ก์ด ๊ธฐ๋ฅ์ด ์ถ๊ฐ๋์ง ์๊ณ , ์ฝ๋๊ฐ ๋ณ๊ฒฝ๋ ๊ฒฝ์ฐ (์ฃผ์ ์ถ๊ฐ ๋ฐ ์์ ํฌํจ)
- ๐ docs: ๋ฌธ์ ์์ (README ์์ ์)
- ๐ build: ๋น๋ ๊ด๋ จ ํ์ผ ์์ ๋ฐ ์ญ์ ํ ๊ฒฝ์ฐ
- โ test: ํ ์คํธ ์ฝ๋, ๋ฆฌํฉํฐ๋ง ํ ์คํธ ์ฝ๋ ์ถ๊ฐ (ํ๋ก๋์ ์ฝ๋ ๋ณ๊ฒฝ X)
- โป๏ธ refactor: ์ฝ๋ ๋ฆฌํฉํฐ๋ง
- ๐ hotfix: ๊ธด๊ธ ์์
์ ๋ชฉ (ํ์)
์ด๋ชจ์ง ๋ฐ ํ์ ์ ์ถ๊ฐํ์ฌ 50์ ์ด๋ด๋ก ๋ณ๊ฒฝ์ฌํญ์ ๊ฐ๋จํ๊ฒ ์์ฝํ์ธ์.
์: โจ feat: ์๋ก์ด ๋ก๊ทธ์ธ ๊ธฐ๋ฅ ์ถ๊ฐ๋ณธ๋ฌธ (์ ํ)
๋ณ๊ฒฝํ ์ด์ ๋ฅผ ์์ธํ๊ฒ ์ค๋ช ํ์ธ์. ์ฌ๋ฌ ์ค์ผ ๊ฒฝ์ฐ, ๊ฐ ์ค์ ๊ธธ์ด๋ 72์๋ฅผ ๋์ง ์๊ฒ ์์ฑํ์ธ์.
์์:
- ์ด์ 1
- ์ด์ 2
Footer (์ ํ)
๊ด๋ จ๋ ์ด์ ๋ฒํธ๋ ์ฐธ๊ณ ์ ๋ณด๋ฅผ ์ถ๊ฐํ์ธ์.
์์: Resolves: 123
GitHub Actions๋ฅผ ์ฌ์ฉํ์ฌ ์ฝ๋๊ฐ ์๊ฒฉ ์ ์ฅ์์ ํธ์๋ ๋๋ง๋ค CI/CD ํ์ดํ๋ผ์ธ์ ์คํ
ํด๋น workflow ๋ ์ฝ๋ ํ์ง์ ์ ์งํ๊ณ ์ ํ๋ฆฌ์ผ์ด์
์ ์์ ์ฑ์ ํ๋ณดํ๊ธฐ ์ํด ๋ค์ํ ์์
์ ์๋์ผ๋ก ์ํ
.github/workflows/fastapi-ci.yml
- Push ์ด๋ฒคํธ: ์ฝ๋๊ฐ ์ ์ฅ์์
push๋ ๋ ์๋ ์คํ๋ฉ๋๋ค.
- ์ด์ ์ฒด์ : Ubuntu 20.04
- Python ๋ฒ์ : 3.12
- ๋ฐ์ดํฐ๋ฒ ์ด์ค ์ค์ ์ ๋ค์๊ณผ ๊ฐ์ ํ๊ฒฝ ๋ณ์๋ฅผ ์ฌ์ฉํฉ๋๋ค:
DB_HOST: 127.0.0.1DB_PORT: 3306DB_USER: rootDB_PASSWORD: 1234DB_DATABASE: oz_fastapi4.1. ์ฝ๋ ์ฒดํฌ์์
์ ์ฅ์์ ์ฝ๋๋ฅผ ๊ฐ์ ธ์ต๋๋ค.4.2. Python ํ๊ฒฝ ์ค์
- Python 3.12 ๋ฒ์ ์ ์ค์ ํฉ๋๋ค.
- ํ๊ตญ ์๊ฐ๋(KST)๋ก ๋ณ๊ฒฝํฉ๋๋ค.
4.3. MySQL ๋ฐ์ดํฐ๋ฒ ์ด์ค ์ด๊ธฐํ
- MySQL ์๋ฒ๋ฅผ ์์ํฉ๋๋ค.
- ์ง์ ๋ ๋ฐ์ดํฐ๋ฒ ์ด์ค ๋ฐ ์ฌ์ฉ์ ์ค์ ์ ๊ตฌ์ฑํฉ๋๋ค.
4.4. ์์กด์ฑ ์ค์น
- Poetry๋ฅผ ์ค์นํ๊ณ ํ๋ก์ ํธ์ ์์กด์ฑ์ ์ค์ ํฉ๋๋ค.
4.5. ์ฝ๋ ํ์ง ๊ฒ์ฌ
black: ์ฝ๋ ์คํ์ผ ํ์ธ.isort: ์ํฌํธ ์ ๋ ฌ ํ์ธ.mypy: ์ ์ ํ์ ๊ฒ์ฌ.4.6. ํ ์คํธ ์คํ
pytest: ํ ์คํธ ์คํ ๋ฐ ์ฝ๋ ์ปค๋ฒ๋ฆฌ์ง ๋ณด๊ณ ์ ์์ฑ.






