{"id":38582,"date":"2024-11-01T18:18:25","date_gmt":"2024-11-01T18:18:25","guid":{"rendered":"http:\/\/atmokpo.com\/w\/?p=38582"},"modified":"2024-11-26T06:43:56","modified_gmt":"2024-11-26T06:43:56","slug":"fastapi-%ec%84%9c%eb%b2%84%ea%b0%9c%eb%b0%9c-alembic%ec%9d%84-%ec%9d%b4%ec%9a%a9%ed%95%9c-%eb%8d%b0%ec%9d%b4%ed%84%b0%eb%b2%a0%ec%9d%b4%ec%8a%a4-%eb%a7%88%ec%9d%b4%ea%b7%b8%eb%a0%88%ec%9d%b4%ec%85%98","status":"publish","type":"post","link":"https:\/\/atmokpo.com\/w\/38582\/","title":{"rendered":"FastAPI \uc11c\ubc84\uac1c\ubc1c, Alembic\uc744 \uc774\uc6a9\ud55c \ub370\uc774\ud130\ubca0\uc774\uc2a4 \ub9c8\uc774\uadf8\ub808\uc774\uc158 \uad00\ub9ac"},"content":{"rendered":"

<\/p>\n

\n
\n

1. \uc11c\ub860<\/h2>\n

FastAPI\ub294 \ud604\ub300\uc801\uc774\uace0 \ube60\ub978 \uc6f9 \ud504\ub808\uc784\uc6cc\ud06c\ub85c, Python 3.6+\uc758 \ud0c0\uc785 \ud78c\ud2b8\ub97c \ud65c\uc6a9\ud558\uc5ec \ube60\ub974\uace0 \uc9c1\uad00\uc801\uc778 API\ub97c \uad6c\ucd95\ud560 \uc218 \uc788\ub3c4\ub85d \ub3c4\uc640\uc90d\ub2c8\ub2e4. \uc544\uc6b8\ub7ec, \ub370\uc774\ud130\ubca0\uc774\uc2a4\uc640\uc758 \uc0c1\ud638\uc791\uc6a9\uc5d0\uc11c \ubc1c\uc0dd\ud560 \uc218 \uc788\ub294 \ub2e4\uc591\ud55c \uc0c1\ud669\uc744 \ud6a8\uc728\uc801\uc73c\ub85c \ucc98\ub9ac\ud558\uae30 \uc704\ud574 Alembic\uacfc \uac19\uc740 \ub370\uc774\ud130\ubca0\uc774\uc2a4 \ub9c8\uc774\uadf8\ub808\uc774\uc158 \ub3c4\uad6c\uac00 \uc911\uc694\ud558\ub2c8\ub2e4. Alembic\uc740 SQLAlchemy\ub97c \uae30\ubc18\uc73c\ub85c \ud558\uba70, \uc5ec\ub7ec\ubd84\uc774 \ub370\uc774\ud130\ubca0\uc774\uc2a4 \uc2a4\ud0a4\ub9c8\uc758 \ubcc0\uacbd \uc0ac\ud56d\uc744 \uad00\ub9ac\ud558\ub294 \ub370 \ub3c4\uc6c0\uc744 \uc90d\ub2c8\ub2e4. \uc774 \uae00\uc5d0\uc11c\ub294 FastAPI\uc640 Alembic\uc744 \uc774\uc6a9\ud558\uc5ec \ub370\uc774\ud130\ubca0\uc774\uc2a4 \ub9c8\uc774\uadf8\ub808\uc774\uc158\uc744 \uc5b4\ub5bb\uac8c \ucc98\ub9ac\ud558\ub294\uc9c0\uc5d0 \ub300\ud574 \uc790\uc138\ud788 \uc0b4\ud3b4\ubcf4\uaca0\uc2b5\ub2c8\ub2e4.<\/p>\n<\/section>\n

\n

2. FastAPI\uc640 Alembic \uac1c\uc694<\/h2>\n

FastAPI<\/strong>\ub294 \ube44\ub3d9\uae30\uc801\uc774\uace0 \uacbd\ub7c9\ud654\ub41c \uc6f9 \uc11c\ubc84\ub97c \uad6c\ucd95\ud560 \uc218 \uc788\uac8c \ud574\uc8fc\ub294 \uac15\ub825\ud55c \ud504\ub808\uc784\uc6cc\ud06c\uc785\ub2c8\ub2e4. RESTful API\ub97c \uc27d\uac8c \ubc1c\uae09\ud560 \uc218 \uc788\ub3c4\ub85d \uc124\uacc4\ub418\uc5b4 \uc788\uc73c\uba70, Swagger UI\uc640 Redoc\uc744 \ud1b5\ud574 \uc790\ub3d9\uc73c\ub85c \ubb38\uc11c\ud654\ub97c \uc9c0\uc6d0\ud569\ub2c8\ub2e4. \uc8fc\ub85c SQLAlchemy ORM\uacfc \ud568\uaed8 \uc0ac\uc6a9\ub418\uba70, \ub370\uc774\ud130\ubca0\uc774\uc2a4\uc640\uc758 \uc6d0\ud65c\ud55c \uc5f0\uacb0\uc744 \ub3c4\uc640\uc90d\ub2c8\ub2e4.<\/p>\n

Alembic<\/strong>\uc740 \ub370\uc774\ud130\ubca0\uc774\uc2a4 \ub9c8\uc774\uadf8\ub808\uc774\uc158\uc744 \uad00\ub9ac\ud558\ub294 \ud234\ub85c, SQLAlchemy\uc640 \ubc00\uc811\ud55c \uad00\uacc4\ub97c \uac00\uc9c0\uace0 \uc788\uc2b5\ub2c8\ub2e4. Alembic\uc744 \uc0ac\uc6a9\ud558\uba74 \ub370\uc774\ud130\ubca0\uc774\uc2a4 \uc2a4\ud0a4\ub9c8 \ubcc0\uacbd\uc744 \ucf54\ub4dc\ub85c \uc791\uc131\ud558\uace0, \uc774\ub97c \ud1b5\ud574 \ubc84\uc804 \uad00\ub9ac\ub97c \ud560 \uc218 \uc788\uac8c \ub429\ub2c8\ub2e4. \uc774\ub97c \ud1b5\ud574 \uac1c\ubc1c\uc790\ub294 \ub370\uc774\ud130\ubca0\uc774\uc2a4 \ubcc0\ud654\uc5d0 \ub300\ud55c \uad00\ub9ac\ub97c \ub354 \uc27d\uac8c \uc218\ud589\ud560 \uc218 \uc788\uc2b5\ub2c8\ub2e4.<\/p>\n<\/section>\n

\n

3. \uac1c\ubc1c \ud658\uacbd \uad6c\uc131<\/h2>\n

\uc774\uc81c FastAPI\uc640 Alembic\uc744 \ud65c\uc6a9\ud560 \uc218 \uc788\ub294 \uac1c\ubc1c \ud658\uacbd\uc744 \uad6c\uc131\ud574 \ubcf4\uaca0\uc2b5\ub2c8\ub2e4. \uc544\ub798\ub294 \ud544\uc694\ud55c \ud328\ud0a4\uc9c0 \uc124\uce58 \ubc29\ubc95\uc785\ub2c8\ub2e4.<\/p>\n

pip install fastapi[all] sqlalchemy alembic<\/code><\/pre>\n
\uc704 \uba85\ub839\uc5b4\ub97c \ud1b5\ud574 FastAPI\uc640 SQLAlchemy, Alembic\uc744 \uc124\uce58\ud569\ub2c8\ub2e4. \uc124\uce58\uac00 \uc644\ub8cc\ub418\uba74, \uc0c8\ub85c\uc6b4 \ud504\ub85c\uc81d\ud2b8 \ub514\ub809\ud1a0\ub9ac\ub97c \uc0dd\uc131\ud558\uace0 \ud558\uc704 \ub514\ub809\ud1a0\ub9ac\ub85c \uc774\ub3d9\ud569\ub2c8\ub2e4.<\/p>\n
mkdir fastapi-alembic-example\ncd fastapi-alembic-example<\/code><\/pre>\n
\uc774\uc81c FastAPI \uc560\ud50c\ub9ac\ucf00\uc774\uc158\uc744 \uad6c\uc131\ud574\ubcf4\uaca0\uc2b5\ub2c8\ub2e4.<\/p>\n<\/section>\n
\n
4. FastAPI \uc560\ud50c\ub9ac\ucf00\uc774\uc158 \uad6c\uc131<\/h2>\n
FastAPI \uc560\ud50c\ub9ac\ucf00\uc774\uc158\uc744 \uc704\ud55c \uae30\ubcf8 \uad6c\uc870\ub97c \ub9cc\ub4e4\uc5b4 \ubd05\uc2dc\ub2e4. \ub2e4\uc74c \ucf54\ub4dc\ub97c \uc0ac\uc6a9\ud558\uc5ec main.py<\/code> \ud30c\uc77c\uc744 \uc0dd\uc131\ud569\ub2c8\ub2e4.<\/p>\n
from fastapi import FastAPI\nfrom sqlalchemy import create_engine\nfrom sqlalchemy.ext.declarative import declarative_base\nfrom sqlalchemy.orm import sessionmaker\n\nDATABASE_URL = \"sqlite:\/\/\/.\/test.db\"\n\nengine = create_engine(DATABASE_URL)\nSessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)\nBase = declarative_base()\n\napp = FastAPI()\n\n# \ub370\uc774\ud130\ubca0\uc774\uc2a4 \uc138\uc158\uc744 \uc0dd\uc131\ud558\uae30 \uc704\ud55c \uc758\uc874\uc131\ndef get_db():\n    db = SessionLocal()\n    try:\n        yield db\n    finally:\n        db.close()\n\n@app.get(\"\/\")\ndef read_root():\n    return {\"Hello\": \"World\"}\n<\/code><\/pre>\n
\uc704\uc758 \ucf54\ub4dc\ub294 SQLite \ub370\uc774\ud130\ubca0\uc774\uc2a4\uc5d0 \uc5f0\uacb0\ud558\uace0 FastAPI \uc560\ud50c\ub9ac\ucf00\uc774\uc158\uc744 \ucd08\uae30\ud654\ud569\ub2c8\ub2e4. \uae30\ubcf8\uc801\uc778 “\/<\/code>” \uc5d4\ub4dc\ud3ec\uc778\ud2b8\ub97c \ud1b5\ud574 \ubc29\ubb38\ud560 \uc218 \uc788\ub294 \uac04\ub2e8\ud55c \ud658\uc601 \uba54\uc2dc\uc9c0\ub97c \ubc18\ud658\ud569\ub2c8\ub2e4.<\/p>\n<\/section>\n
\n
5. Alembic \uc124\uc815<\/h2>\n
Alembic\uc744 \ucd08\uae30\ud654\ud574 \ubcf4\uaca0\uc2b5\ub2c8\ub2e4. \uc544\ub798 \uba85\ub839\uc5b4\ub85c Alembic \uc124\uc815\uc744 \uc0dd\uc131\ud560 \uc218 \uc788\uc2b5\ub2c8\ub2e4.<\/p>\n
alembic init alembic<\/code><\/pre>\n
\uc704 \uba85\ub839\uc5b4\ub97c \uc2e4\ud589\ud558\uba74, alembic<\/code>\uc774\ub77c\ub294 \ub514\ub809\ud1a0\ub9ac\uc640 alembic.ini<\/code> \ud30c\uc77c\uc774 \uc0dd\uc131\ub429\ub2c8\ub2e4. \uc774 \ud30c\uc77c\uc5d0\uc11c \ub370\uc774\ud130\ubca0\uc774\uc2a4 URL\uc744 \uc124\uc815\ud574\uc57c \ud569\ub2c8\ub2e4.<\/p>\n
[alembic]\nscript_location = alembic\n\n[loggers]\nkeys = root,sqlalchemy,alembic\n\n[handlers]\nkeys = console\n\n[formatters]\nkeys = generic\n\n[logger_root]\nlevel = INFO\nhandlers = console\n\n[logger_sqlalchemy]\nlevel = WARN\nhandlers = console\nqualname = sqlalchemy.engine\n\n[logger_alembic]\nlevel = INFO\nhandlers = console\nqualname = alembic\n\n[handler_console]\nclass = StreamHandler\nargs = []\nlevel = NOTSET\nformatter = generic\n\n[formatter_generic]\nformat = %(asctime)s - %(levelname)s - %(message)s\n\n[alembic:app]\n# DB\uc5d0\uc11c \ub9c8\uc774\uadf8\ub808\uc774\uc158\uc744 \uc704\ud55c FastAPI \ub370\uc774\ud130\ubca0\uc774\uc2a4 URL \uc124\uc815\nurl = sqlite:\/\/\/.\/test.db<\/code><\/pre>\n<\/section>\n
\n
6. \ub370\uc774\ud130\ubca0\uc774\uc2a4 \ubaa8\ub378 \uc815\uc758<\/h2>\n
\uc774\uc81c Alembic\uc774 \uad00\ub9ac\ud560 \ub370\uc774\ud130\ubca0\uc774\uc2a4 \ubaa8\ub378\uc744 \uc815\uc758\ud569\ub2c8\ub2e4. \ub2e4\uc74c\uacfc \uac19\uc774 models.py<\/code> \ud30c\uc77c\uc744 \uc0dd\uc131\ud558\uace0 \uc791\uc131\ud569\ub2c8\ub2e4.<\/p>\n
from sqlalchemy import Column, Integer, String\nfrom .database import Base\n\nclass User(Base):\n    __tablename__ = \"users\"\n\n    id = Column(Integer, primary_key=True, index=True)\n    username = Column(String, unique=True, index=True)\n    email = Column(String, unique=True, index=True)\n    full_name = Column(String, index=True)\n    disabled = Column(Boolean, default=False)\n<\/code><\/pre>\n
\uc704\uc640 \uac19\uc774 User<\/code> \ubaa8\ub378\uc744 \uc815\uc758\ud588\uc73c\uba70, \uc774 \ubaa8\ub378\uc740 \uc0ac\uc6a9\uc790\uc758 ID, \uc0ac\uc6a9\uc790 \uc774\ub984, \uc774\uba54\uc77c, \uc804\uccb4 \uc774\ub984 \ubc0f \ube44\ud65c\uc131\ud654 \uc0c1\ud0dc\ub97c \ud3ec\ud568\ud569\ub2c8\ub2e4.<\/p>\n<\/section>\n
\n
7. \ub370\uc774\ud130\ubca0\uc774\uc2a4 \ub9c8\uc774\uadf8\ub808\uc774\uc158 \uc0dd\uc131<\/h2>\n
Alembic\uc744 \uc0ac\uc6a9\ud558\uc5ec \ub370\uc774\ud130\ubca0\uc774\uc2a4 \ub9c8\uc774\uadf8\ub808\uc774\uc158\uc744 \uc0dd\uc131\ud574\uc57c \ud569\ub2c8\ub2e4. \ub2e4\uc74c \uba85\ub839\uc5b4\ub97c \ud1b5\ud574 \uc790\ub3d9\uc73c\ub85c \ub9c8\uc774\uadf8\ub808\uc774\uc158 \ud30c\uc77c\uc744 \uc0dd\uc131\ud560 \uc218 \uc788\uc2b5\ub2c8\ub2e4.<\/p>\n
alembic revision --autogenerate -m \"create users table\"<\/code><\/pre>\n
\uc704 \uba85\ub839\uc5b4\ub97c \uc2e4\ud589\ud558\uba74 alembic\/versions<\/code> \ub514\ub809\ud1a0\ub9ac\uc5d0 \uc0c8\ub85c\uc6b4 \ub9c8\uc774\uadf8\ub808\uc774\uc158 \ud30c\uc77c\uc774 \uc0dd\uc131\ub429\ub2c8\ub2e4. \uc774 \ud30c\uc77c\uc740 \uc0dd\uc131\ub41c users<\/code> \ud14c\uc774\ube14\uc5d0 \ub300\ud55c \ubaa8\ub4e0 \ubcc0\uacbd \uc0ac\ud56d\uc744 \ub2f4\uace0 \uc788\uc2b5\ub2c8\ub2e4.<\/p>\n<\/section>\n
\n
8. \ub9c8\uc774\uadf8\ub808\uc774\uc158 \uc801\uc6a9<\/h2>\n
\uc0dd\uc131\ub41c \ub9c8\uc774\uadf8\ub808\uc774\uc158 \ud30c\uc77c\uc744 \ub370\uc774\ud130\ubca0\uc774\uc2a4\uc5d0 \uc801\uc6a9\ud558\uae30 \uc704\ud574 \uc544\ub798\uc640 \uac19\uc774 \uba85\ub839\uc5b4\ub97c \uc2e4\ud589\ud569\ub2c8\ub2e4.<\/p>\n
alembic upgrade head<\/code><\/pre>\n
\uc704 \uba85\ub839\uc5b4\ub97c \uc2e4\ud589\ud558\uba74 \ub370\uc774\ud130\ubca0\uc774\uc2a4\uc5d0 users<\/code> \ud14c\uc774\ube14\uc774 \uc0dd\uc131\ub429\ub2c8\ub2e4. \uc774 \uacfc\uc815\uc744 \ud1b5\ud574 Alembic\uc774 \ub370\uc774\ud130\ubca0\uc774\uc2a4 \uc2a4\ud0a4\ub9c8\ub97c \uad00\ub9ac\ud558\ub294\ub370 \ud544\uc694\ud55c \uae30\ubcf8\uc801\uc778 \uc124\uc815\uc744 \ub9c8\ucce4\uc2b5\ub2c8\ub2e4.<\/p>\n<\/section>\n
\n
9. FastAPI\uc640 Alembic \uc5f0\ub3d9<\/h2>\n
\uc774\uc81c FastAPI \uc560\ud50c\ub9ac\ucf00\uc774\uc158\uc5d0\uc11c Alembic\uc73c\ub85c \ub9cc\ub4e0 \ub370\uc774\ud130\ubca0\uc774\uc2a4 \ubaa8\ub378\uc744 \uc5f0\ub3d9\ud574 \ubcf4\uaca0\uc2b5\ub2c8\ub2e4. main.py<\/code> \ud30c\uc77c\uc744 \uc218\uc815\ud558\uc5ec \uc0ac\uc6a9\uc790\uc758 \ub370\uc774\ud130\ub97c \ucc98\ub9ac\ud558\ub294 \uc5d4\ub4dc\ud3ec\uc778\ud2b8\ub97c \ucd94\uac00\ud569\ub2c8\ub2e4.<\/p>\n
from fastapi import FastAPI, Depends, HTTPException\nfrom sqlalchemy.orm import Session\nfrom . import models\nfrom .database import SessionLocal, engine\n\nmodels.Base.metadata.create_all(bind=engine)\n\n@app.post(\"\/users\/\", response_model=models.User)\ndef create_user(user: models.User, db: Session = Depends(get_db)):\n    db.add(user)\n    db.commit()\n    db.refresh(user)\n    return user\n<\/code><\/pre>\n
\uc704 \ucf54\ub4dc\ub97c \ud1b5\ud574 \/users\/<\/code> \uc5d4\ub4dc\ud3ec\uc778\ud2b8\uac00 \uc0dd\uc131\ub418\uc5b4 \uc0ac\uc6a9\uc790\ub97c \ucd94\uac00\ud560 \uc218 \uc788\uac8c \ub418\uc5c8\uc2b5\ub2c8\ub2e4.<\/p>\n<\/section>\n
\n
10. \uacb0\ub860<\/h2>\n
FastAPI\uc640 Alembic\uc744 \ud1b5\ud569\ud558\uc5ec \ub370\uc774\ud130\ubca0\uc774\uc2a4 \ub9c8\uc774\uadf8\ub808\uc774\uc158\uc744 \uad00\ub9ac\ud558\ub294 \ubc29\ubc95\uc5d0 \ub300\ud574 \uc54c\uc544\ubcf4\uc558\uc2b5\ub2c8\ub2e4. \uc774 \uacfc\uc815\uc5d0\uc11c FastAPI\uc758 \uae30\ubcf8\uc801\uc778 \uc124\uc815\uacfc Alembic\uc744 \ud1b5\ud55c DB \ub9c8\uc774\uadf8\ub808\uc774\uc158\uc774 \uc5b4\ub5bb\uac8c \uc774\ub8e8\uc5b4\uc9c0\ub294\uc9c0 \uc0b4\ud3b4\ubcf4\uc558\uc2b5\ub2c8\ub2e4. \uc774\ub7ec\ud55c \ubc29\uc2dd\uc744 \ud1b5\ud574 \uc5ec\ub7ec\ubd84\uc758 \uc6f9 \uc560\ud50c\ub9ac\ucf00\uc774\uc158\uc5d0\uc11c \ub370\uc774\ud130\ubca0\uc774\uc2a4 \ubcc0\uacbd \uc0ac\ud56d\uc744 \ubcf4\ub2e4 \ud6a8\uacfc\uc801\uc73c\ub85c \uad00\ub9ac\ud560 \uc218 \uc788\uc744 \uac83\uc785\ub2c8\ub2e4.<\/p>\n<\/section>\n
\n
11. \ucc38\uace0 \uc790\ub8cc<\/h2>\n