Ubuntu上で Fast API와 관계型 데이터베이스를 사용하는 方法

소개

FastAPI는 Python으로 API를 빌드하기 위한 고성능, 유용性 있는 웹 프레임웍이며 빨라게 인기를 얻었습니다. 관계형 데이터베이스와 搭配하면 FastAPI를 사용하여 強力한, 스케일abel한 응용 프로그램을 생성할 수 있습니다. 이 가이드는 Ubuntu 24.04 기기에서 관계형 데이터베이스와 搭配된 FastAPI 응용 프로그램을 설정하는 과정을 guiding할 것입니다. 필요한 도구를 설치하는 것부터 데이터베이스를 구성하고 API 엔드포인트를 생성하는 것까지 모두 다룹니다.

PostgreSQL 데이터베이스와 搭配하여 FastAPI 사용

• Python 환경 세팅
• 가상 환경 생성하고 활성화
• PostgreSQL 설치하고 设置
• 快速的FastAPI 응용 프로그램 만들기
• 필요한 라이브러리 설치
• Python 응용 프로그램 실행
• FastAPI 응용 프로그램 엔드포인트 테스트

前提条件

이 튜토리얼의 단계를 따라하기 전에는

• Ubuntu를 실행하고 있는 서버와 sudo 권한을 가진 덜 root 유저가 있고, 활성화된 防火墙이 필요합니다. 이 조건을 만족시키는 방법에 대한 지침은 이 목록에서 您的Ubuntu 분发了를 선택하고 초기 서버 설정 가이드를 따라주시기 바랍니다. Ubuntu의 지원하는 버전을 사용해야 합니다.

• Linux 명령行(command line)에 대한 熟悉ity. Linux 명령行에 대한 인TRODUCTION 또는 refresher, Linux command line primer를 이용하여 가능합니다.

• Ubuntu 터미널에서 sudo apt-get update을 실행하여 시스템에 설정된 저장소から Software를 얻을 수 있는 最新 version과 보안 更新을 가지고 있는지 확인하십시오.

단계 1 – Python 환경 세팅

Ubuntu 24.04는 기본적으로 Python 3를 搭載합니다. 终端을 열고 다음 명령을 실행하여 Python 3의 설치 여부를 다시 확인하십시오 :

python3 --version

Python 3이 이미 您的 컴퓨터에 설치되어 있다면, 이 명령어는 Python 3의 현재 버전을 리턴합니다. 만약 설치되어 있지 않다면, 다음 명령어를 실행하여 Python 3의 설치를 할 수 있습니다.

sudo apt install python3

次に, 您的 시스템에서 pip와 dev パッケージ インストーラ를 설치해야 합니다. 终端에서 다음 명령어를 실행하십시오 :

sudo apt install python3-pip python3-dev

이 튜토리얼에서는 포스greSQL를 관련 db로 사용할 것입니다. PostgreSQL 데이터베이스에 대응하여 대화하려면 libpq-dev를 以下的 명령어를 사용하여 설치해야 합니다.:

sudo apt install libpq-dev

단계 2 – 仮想 환경 만들기 및 활성화

다음 단계는 우분투 설치 내에 仮想 환경을 생성하는 것입니다. 이를 통해 Python 패키지를 시스템 환경과 isolation 시키ます. 이를 실행하려면 작업 디렉터리로 가서 다음 명령어 집합을 실행합니다.:

python3 -m venv fastapi-env

이 명령어는 fastapi-env이라는 이름의 새 仮想 환경을 생성합니다. 이 仮想 환경은 다른 프로젝트와 isolate 된 자신의 Python 패키지 집합을 갖습니다.

이제 이 격리된 환경 내에서 설치하는 모든 패키지가 설치 되도록 하려면, 다음 명령어를 실행하여 활성화해야 합니다.:

source fastapi-env/bin/activate

실행 후, 终端에 仮想 환경 이름을 사전fix하여 이렇게 보일 것입니다.:

Output
(fastapi-env) ubuntu@user:

Step 3 – PostgreSQL 설치와 세팅

다음 단계는 PostgreSQL(또는 관련 이슈 데이터베이스 중 하나)을 설치하는 것입니다.

sudo apt install postgresql postgresql-contrib

이제, 가상 환경 내에서 PostgreSQL 서비스를 시작하고 사용할 수 있게 하는 시간입니다.

sudo systemctl start postgresql
sudo systemctl enable postgresql

FastAPI와 함께 PostgreSQL을 설치하고 사용하기 위해서는 몇 가지 것을 설치해야 합니다:

1. asyncpg: 이것은 非阻塞 PostgreSQL 드라이버로, FastAPI가 PostgreSQL 데이터베이스에 대한 인터셉션을 허용합니다.
2. SQLAlchemy: 이것은 Python 코드로 섹셋과 쿼리를 직접 쓰는 것 대신에 데이터베이스 스키마와 쿼리를 Python 코드로 관리하는 ORM 도구입니다.
3. databases: 이것은 SQLAlchemy가 非阻塞 操作을 行うために 필요한 的非阻塞 데이터베이스 라이브러리입니다.

이러한 것을 설치하기 위해서는 다음과 같은 통합 명령을 실행합니다:

pip install asyncpg sqlalchemy databases

次에, 필요한 권한을 가진 Postgres 데이터베이스와 사용자를 만듭니다.

sudo -u postgres psql
CREATE DATABASE <user_db>;
CREATE ROLE <username> WITH PASSWORD '<password>';
GRANT ALL PRIVILEGES ON DATABASE <user_db> TO <username>;
exit

Step 4 – 샘플 파이썬 응용 프로그램 생성

Python 응용 프로그램을 만들어야 합니다. 이를 통해 데이터베이스에 FastAPI를 사용하여 연결하고자 합니다. 이미 실행 중인 Python 응용 프로그램이 없다면, 다음 단계를 따라 빠르게 하나 생성할 수 있습니다.

프로젝트 디렉터리에 postgres_db.py라는 새 Python 파일을 만듭니다.

nano postgres_db.py

텍스트 에디터에서는 데이터베이스 연결을 생성하고 데이터베이스 내에 테이블을 생성하는 로직을 적을 것입니다. 이 예에서는 PostgreSQL 데이터베이스 연결을 databases 패키지를 사용하여 생성하고 SQLAlchemy를 사용하여 books 테이블의 구조를 정의합니다.

from databases import Database
from sqlalchemy import create_engine, MetaData, Table, Column, Integer, String, Float

DB_URL = "postgresql://username:password@localhost/user_db"

database = Database(DB_URL)
metadata = MetaData()

books = Table (
  "books",
  metadata,
  Column("id", Integer, primary_key=True, index=True),
  Column("title", String, index=True),
  Column("author", String, index=True),
  Column("price", Float),
)

engine = create_engine(DB_URL)
metadata.create_all(engine)

이 파일을 저장하고 닫습니다.

次に, 동일한 디렉터리에 main.py를 생성합니다.

nano main.py

이 파일에는 응용 프로그램의 주요 로직을 적습니다:

from fastapi import FastAPI
from typing import List
from pydantic import BaseModel
from postgres_db import books, database

app = FastAPI()

class BookCreate(BaseModel):
    title: str
    author: str
    price: float

class BookResponse(BaseModel):
    id: int
    title: str
    author: str
    price: float

class Config:
  orm_mode=True

@app.on_event("startup")
async def startup():
    await database.connect()

@app.on_event("shutdown")
async def shutdown():
    await database.disconnect()

@app.post("/books/", response_model=BookResponse)
async def create_book(book: BookCreate):
    query = books.insert().values(title=book.title, author=book.author, price=book.price)
    last_book_id = await database.execute(query)

    query = books.select().where(books.c.id == last_book_id)
    inserted_book = await database.fetch_one(query)
    return inserted_book

@app.get("/books/", response_model=List[BookResponse])
async def get_books():
    query = books.select()
    return await database.fetch_all(query)

이 코드는 FastAPI를 사용하여 PostgreSQL 데이터베이스에 新书 条目을 쓰고, 그것에서 도서 목록을 가져옵니다.

第五步 – 安装所需库

Python 응용 프로그램에서는 여러 라이브러리와 패키지를 참조하고 있습니다. 응용 프로그램을 실행하기 전에는 필요한 라이브러리를 설치해야 합니다.

pip install fastapi uvicorn psycopg2

第六步 – 运行 Python 应用程序

이제 여러분이 만든 응용 프로그램을 실행할 시간입니다.

uvicorn main:app --reload

uvicorn는 非阻塞 서버 게이트웨이 인터페이스(ASGI)로, FastAPI 응용을 실행하는 데 사용되는 것입니다.uvicorn를 사용하는 것은 FastAPI가 자신이 非阻塞 웹 프레임웍이기 때문에 가장 좋은 방법입니다.

위의 명령어가 에러를 만나지 않고 실행되면, 다음과 같은 표시를 볼 수 있습니다.

Output
INFO:     Will watch for changes in these directories: ['/path/to/your/project']
INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO:     Started reloader process [XXXX] using StatReload
INFO:     Started server process [YYYY]
INFO:     Waiting for application startup.
INFO:     Application startup complete.

웹 브라우저에서 http://127.0.0.1:8000로 이동하여 쿼리 결과를 보실 수 있습니다.

Step 7 [OPTIONAL] – Test the Endpoints

여러분의 main.py에 정의한 POST와 GET 端点을 실제 HTTP 요청으로 서버에 送信하여 테스트 할 수 있습니다.

{
  "title": "The Great Gatsby",
  "author": "F. Scott Fitzgerald",
  "price": 10.99
}

同样地, GET 요청을 同样の 서버에 보내면 Postgres 데이터베이스에 존재하는 도서 목록을 가져올 수 있습니다.

Conclusion

이 튜토리얼에서는 פוסטgreSQL 데이터베이스와 상호 작용하는 간단한 FastAPI 응용 프로그램을 설정하는 과정을 이해하는 것을 도와줍니다.이러한 단계는 AI 응용에서도 특히 AI 모델과 상호 작용하거나 AI 과정과 관련된 데이터를 관리하기 위해 웹 API를 만들 때 유용합니다.이러한 기반을 마련하면 이제 자신의 FastAPI 프로젝트를 빌드하고 확장할 수 있습니다.

FastAPI로 작업하는 방법에 대한 자신의 글을 기대하세요.