📌 Basic

자세한 코드는 점프 투 API를 참고하시길 바랍니다. 

기본적인 내용은 점프 투 Fastapi의 내용을 공부하며 알게 된 내용들을 설명한다. 구글에 검색하여 공부해보면 알겠지만, 혼자서 따라할 수 있으며, 완성된 코드들이 주어진다는 점에서, 결과물을 빠르게 볼 수 있는 장점이 있다. 그러나 우리는 책에 나오는 주제에 국한하여 개발을 할 것이 아니기 때문에, 기능들이 얼마나 범용성 있게 쓰일 수 있는지를 보아야하고, FLASK와의 속도차이가 매우 유의미할 정도로 나기 때문에, 어느 부분에서 이 프레임워크가 효율적인 작업을 보여주는지, 어느 부분에서 불편한지를 인지하면, 기존에 만들었던 FLASK 개인 프로젝트에 대한 재구성을 하는데 도움이 될 것 같다.

📌 이전 포스팅 필독

해당 포스팅을 작성하며, 알고 싶은 부분들은, 이전 포스팅에서 flask로 회원가입 폼을 작성하였던 기능들을 Fastapi로 어떻게 구현하는지, 그리고 어떤 기능들이 어떤 역할을 하고 있는지에 중점을 두고 작성하였다. 기본적으로 회원가입 폼이 어떤 원리로 작동하고, 웹페이지와 상호작용하며, 필요한 데이터들은 무엇이고, 처리과정에서 어떤 것들을 검사하여야 하는지에 대한 사전 정보가 있으면 해당글을 이해하는데 도움이 될 것이다. Flaks 와 Fastapi는 비슷한 점이 굉장히 많다는 점을 알 수 있게 될 것이다.

📌 FastAPI

FastAPI

이름부터 굉장히 빠르다고 말해준다. 맞다. 매우 빠르다. 속도가 느린게 단점이라고 문제를 지적받는 파이썬의 입장에서 이것은 혁신적인 내용이 아닐 수 없다. 직접 데이터를 검색해도 나오겠지만, 기본적인 속도는 내가 사용했던 flask의 두배도 아니고 몇 배다 몇 배. 굉장히 많이 차이가 나기도 하고, flask와 유사하다라는 점에서 공부를 하면 좋을 것 같다는 생각에 포스팅을 하게 되었다.

기본적으로 FastAPI import는 flaks에서 Flask import하는거랑 똑같다고 보면된다.

from fastapi import APIRouter, Depends, HTTPException, FastAPI

from fastapi import APIRouter, Depends
from sqlalchemy.orm import Session
from starlette import status

from database import get_db
from domain.question import question_schema, question_crud

# 일단 임포트 관련 에러 밑줄나는건 다무시하면 될듯

router = APIRouter(
    prefix="/api/question",
)

# 라우팅이란 FastAPI가 요청받은 URL을 해석하여 그에 맞는 함수를 실행하여 그 결과를 리턴하는 행위를 말한다.
'''
db: Session 문장의 의미는 db 객체가 Session 타입임을 의미
FAST API의 Depends는 매개변수로 전달받은 함수를 실행시킨 결과를 리턴한다. db 객체에는 get_db 제네레이션에 의해 생성된
객체가 주입된다. get_db 함수에 자동으로 contextmanager가 적용되기 때문에(Depends에서 적용하게끔 설계되어있다) database의
get_db 함수는 다음과 같이 적용한 (@contextlib.contextmanager 어노테이션을 제거해야한다)
--
@router.get 어노테이션에 response_model 추가 
question_list 함수의 리턴 값은 Question schema로 구성된 리스트임을 뜻한다. 
'''


@router.get("/list", response_model=list[question_schema.Question])
def question_list(db: Session = Depends(get_db)):
    # 오류 여부에 상관없이 with문을 벗어나는 순간 db.close()가 실행되므로 보다 안전한 코드로 변경된 것이다.
    _question_list = question_crud.get_question_list(db)
    return _question_list


@router.get("/detail/{qeustion_id}", response_model=question_schema.Question)
def question_detail(question_id: int, db: Session = Depends(get_db)):
    question = question_crud.get_question(db, question_id=question_id)
    return question


@router.post("/create", status_code=status.HTTP_204_NO_CONTENT)
def question_create(_question_create: question_schema.QuestionCreate,
                    db: Session = Depends(get_db)):
    question_crud.create_question(db=db, question_create=_question_create)

Router

Flask에서는 blueprint를 사용하여, 라우팅을 구분하고, 메인 앱으로 해당기능을 불러와서 사용했는데, 그 기능들을 fastapi에서는 router를 이용해서 조절이 가능하다. 별도의 이름지정도 필요 없이, url_prefix 기능도 사용할 수 있기 때문에 굉장히 편리한 것 같다. (해당 기능에 대한 내용은 flask설명부분에 나와있으니 참조하도록 하자). blueprint 버퍼 불러오는 것을 구분할 필요 없이, 메인함수에서 inlcude_router 기능을 사용하면 되니 참조하도록 하자.

Dependency Injection

시스템을 구현하는 데 사용되는 특별한 도구이다. 의존성 주입은 함수나 클래스 메서드에 다른 객체, 함수 또는 클래스를 주입하여 코드를 더 효과적으로 관리하고 의존성을 관리하는 데 도움을 준다.

아래는 FastAPI 공식문서 예시코드이다.

from typing import Union

from fastapi import Depends, FastAPI

app = FastAPI()


async def common_parameters(
    q: Union[str, None] = None, skip: int = 0, limit: int = 100
):
    return {"q": q, "skip": skip, "limit": limit}


@app.get("/items/")
async def read_items(commons: dict = Depends(common_parameters)):
    return commons


@app.get("/users/")
async def read_users(commons: dict = Depends(common_parameters)):
    return commons

async는 비동기 라는 것인데, 해당 개념은 지금 중요한게 아니므로 넘겨두도록하자.

Depends에 대한 이해:
게임을 예로 들어보자. 예를 들어, A라는 스킬을 쓰기 위해서는 반드시 B라는 스킬이 선행되어야하고, 내가 가진 스킬은 매우많다.
만약 Depends를 사용하지 않았다면, A라는 기술을 사용하기 위해, 일일이 B스킬의 커맨드를 입력해야할것이다.
그러나 Depends를 통해, A 기술에 B 기술을 의존시키면, 내가 A 기술을 사용했을 때, 알아서 B 기술이 나가고 A 기술이 나가는 것이다.
B A B A B A 순서대로 쓰던 이런 불필요한 작업들은 Depends에 의해
A A A A로 바뀌는 것이다. 이 얼마나 편리한가??
별거 아닌 것처럼 보이겠지만, 프로젝트를 하면서 생각보다 몇가지 안되는 유저의 정보를 반복적으로 사용해야하는 경우가 많다. 그렇기 때문에 매우 유용하다는 것이다.

HTTPException

웹 애플리케이션을 사용하는 도중, 오류가 발생했을 때 해당 오류코드에 대한 처리를 도와주는 기능이다.

Copy code
from fastapi import FastAPI, HTTPException

app = FastAPI()

@app.get("/items/{item_id}")
async def read_item(item_id: int):
    if item_id == 42:
        raise HTTPException(status_code=404, detail="Item not found")
    return {"item_id": item_id}

만약 입력받은 item_idrk 42일 경우에 404 상태코드와 "Item not found"문구가 함께 클라이언트로 반환이 된다.

📌 Database

해당 예제에서는 데이터베이스 연결 코드로 sqlalchemy와 sqlalchemy.orm을 사용하였다.

from sqlalchemy import create_engine
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import sessionmaker

# 데이터베이스 접속주소
SQLALCHEMY_DATABASE_URL = 'sqlite:///./myapi.db'

'''
create_engine sessionmaker 는 따라야할 정해진 규칙이지만
autocommit은 잘 알아야한다. autocommit=False 라고 저장하면
commit이라는 사인을 줄 때만 데이터가 저장된다. 그리고 rollback이 가능하다. 
auto commit=True 일 경우에는 rollback 은 작동하지 않는다
'''

engine = create_engine(
    SQLALCHEMY_DATABASE_URL, connect_args={"check_same_thread": False}
)

SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)

Base = declarative_base()
# base 클래스는 데이터베이스 모델 생성에 쓸 객체이다.


def get_db():
    db = SessionLocal()
    try:
        yield db
    finally:
        db.close()

create_engine

SQLAlchemy에서 데이터 베이스 연결을 관리하는데 사용되는 함수. 데이터베이스 URL을 인수로 받아 데이터베이스를 연결하고 상호작용하는 역할을 한다. 풀링과 스레딩등 고급 설정을 지원한다.

declarative_base

SQLAlchemy의 ORM(Object-Relational Mapping)을 사용하여 데이터베이스 모델을 정의하는 데 사용된다. declarative_base 함수는 데이터베이스 모델의 기본 클래스를 생성, 이 기본 클래스를 상속하여 정의하고 이를 통해 테이블과 매핑되는 클래스를 생성할 수 있다.

ORM 의 경우 SQL문법을 배우지 않아도 된다는 장점이 있다. 하지만 장점이 있으면 단점도 있겠죠? ㅎㅎ

sessionmaker, session

Session = sessionmaker(bind=engine)
bind와 engine은 어떤 데이터베이스를 연결할지 정하는 부분이고 sessionmaker를 통해, 세션 객체를 사용한다.

session은 데이터 베이스와 트랜잭션을 나타내는 객체이다. 해당 sessionmaker로 만들어진 것을 쓸려면
session = Session()처럼 선언해서 객체를 만들면 된다.
session을 통해 데이터베이스에 데이터를 넣는 등의 여러가지 기능들을 할 수 있다.

📌 pydantic

BaseModel

BaseModel은 모델을 정의할 때 사용된다. 이를 상속하고 필드를 클래스 변수로 선언한다. 데이터 모델 필드의 타입힌트와 기본 값 설정이 가능하다

from pydantic import BaseModel

class User(BaseModel):
    username: str
    email: str

아마도 c나 c++ 써봤던 사람들은 익숙할만한 자료형 선언들을 할 수 있다. 

validator

@validator
데코레이터 형식으로 선언하여, 데이터 모델 필드에 대해 사용자 지정 유효성 검사가 가능하다.

from pydantic import BaseModel, validator

class User(BaseModel):
    username: str
    email: str

    @validator('email')
    def validate_email(cls, value):
        if not value.endswith('@example.com'):
            raise ValueError('이메일 주소는 example.com 도메인을 사용해야 합니다.')
        return value

@validator('email')데코레이터는 email 필드에 대한 유효성 검사 규칙을 정의하며, 이메일 주소가 example.com 도메인으로 끝나지 않으면 예외를 발생시키는 역할을 하고 있다.

cls는 클래스 자체, value는 email 필드에 할당된 값을 말한다.
현재 예시에서는
클래스는 User가 되는 것이고 value는 email 필드에 들어있는 값이다. value를 통해 유효성 작업이 이루어진다.

📌 starlette

이 녀석 때문에 애좀 먹었다. 제대로 이해하지 않고 간다면, 후에 FastAPI로 개인 프로젝트를 진행할 때 문제가 될 수 있는 부분일 것 같다. 동작하는 url과 관련한 민감한 부분이다.

CORSMiddleware, status

우선 예시코드이다.

from starlette.middleware.cors import CORSMiddleware
from starlette import status

app.add_middleware(
    CORSMiddleware,
    allow_origins=["*"],  # 별표(*)는 모든 도메인에서의 요청을 허용
    allow_credentials=True,  # 자격 증명 정보 (예: 쿠키, 인증)를 허용
    allow_methods=["*"],  # 모든 HTTP 메서드 허용
    allow_headers=["*"],  # 모든 HTTP 헤더 허용
    expose_headers=["Content-Disposition"],  # 브라우저에 노출할 헤더 지정
)

@app.post("/api/some_endpoint", status_code=status.HTTP_201_CREATED)
async def create_resource():
    # 여기서 자원 생성 논리를 구현
    return {"message": "Resource created successfully"}

CORSMiddleware:
Cross-Origin Resource Sharing (CORS)를 처리하는 미들웨어이다.
CORS는 웹 브라우저에서 다른 도메인으로부터의 HTTP 요청을 허용하도록 하는 보안 기능입니다. 즉, 웹 애플리케이션이 서로 다른 도메인의 자원을 요청할 때 브라우저에서 보안 정책을 준수하도록 돕는 기능을 한다. 일종의 보안과 관련된 부분인데, 점프투 FASTAPI를 따라오다 보면 아마 orgin부분에서 문제를 마주하게 될 것 이다. 원래 모든도메인의 요청을 허락하지 않고,

orgins [ 
 #여기는 사용자가 허용할 URL들을 넣습니다.
]

이렇게 orgins 변수를 따로 선언하여, allow_orgins=orgins 형식으로 사용한다. 예제코드에서는, 127.0.0.1:5173에 대한 orgin은 허용했으나, 나중에 svelte를 사용해보면 아는데 localhost:5173에 대한 허용을 해놓지 않아서, 제 아무리 svelte를 실행시켜 보아도, 스웨거를 통해 넣은 데이터가 진짜

죽었다 깨어나도 안보이더라

그러니 혹시 하다가 막히면 이부분을 반드시 적용해보길 바란다... 물론 하자마자 바로해보지는 말고, 스웨거를 통해 데이터를 잘 주고받는지 확인한 후, 해보길 추천한다.
status:
이 친구는 익숙할 것이다. http 응답상태 코드를 정의하는 상수다. 이건 개념보다 본인이 직접 오류들을 마주하며, 여러가지 상태코드를 마주해보길 적극 권장한다. 특히 404error(Not Found)는 아마 일상생활에서도 흔히 경험하는 코드일 것.

📌 swagger

그냥 써봐라

제발 좀 써봐라
제발
API를 호출하고 테스트하는 데 직접 브라우저에서 사용할 수 있으며 예상되는 응답을 미리 확인할 수 있는 아주 파격적인 기능이다. 그냥 매우매우매우 매우우우우우편리하다고 생각하면된다. 자세한 동작과정은 솔직히 알려주기엔 너무 쉽다. 예제를 따라가면서 꼭 해보길 바란다.