[작성자:] root

최근 몇 년간 웹 애플리케이션 개발은 급속도로 발전해왔고, 그중에서도 Python을 기반으로 한 웹 프레임워크들은 주목을 받고 있습니다. 특히, FastAPI는 Python의 비동기 기능을 활용하여 뛰어난 성능과 쉽고 간결한 문법을 제공하여 많은 개발자들 사이에서 인기를 끌고 있습니다. 본 포스트에서는 FastAPI를 사용한 백엔드 서버 개발의 기본 개념과 AWS에 배포하는 방법에 대해 알아보겠습니다.

1. FastAPI란?

FastAPI는 Python으로 작성된 현대적인 웹 프레임워크로, API 서버 구축의 효율성을 극대화하는 데 초점을 두고 있습니다. 주요 특징은 다음과 같습니다.

• 빠른 실행 속도: Starlette와 Pydantic을 기반으로 하여 최고 수준의 성능을 자랑합니다.
• 타입 힌트 지원: Python의 타입 힌트를 활용하여 코드의 가독성을 높이고, 자동 문서화를 지원합니다.
• 비동기 지원: 비동기 프로그래밍을 쉽게 활용할 수 있도록 도와줍니다.
• 자동 문서화: OpenAPI 명세를 자동으로 생성하여 API 문서를 쉽게 확인할 수 있습니다.

2. FastAPI 설치하기

FastAPI를 설치하기 위해서는 Python이 필요합니다. 아래와 같이 pip를 사용하여 FastAPI와 uvicorn을 설치할 수 있습니다:

pip install fastapi uvicorn
    

3. FastAPI 기본 예제

이제 FastAPI로 간단한 API 서버를 만들어보겠습니다. 다음 코드는 “Hello, World!”를 반환하는 기본적인 FastAPI 서버입니다:

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def read_root():
    return {"message": "Hello, World!"}

if __name__ == "__main__":
    import uvicorn
    uvicorn.run(app, host="0.0.0.0", port=8000)
    

위 코드를 main.py라는 파일명으로 저장한 후, 아래 명령어로 실행할 수 있습니다:

uvicorn main:app --reload
    

4. FastAPI의 데이터 모델 사용하기

FastAPI는 Pydantic을 통해 데이터 모델을 정의하고 검증할 수 있습니다. 아래 예시는 사용자 정보를 POST 요청으로 받는 API를 구현한 것입니다:

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

class User(BaseModel):
    name: str
    age: int

@app.post("/users/")
async def create_user(user: User):
    return {"name": user.name, "age": user.age}
    

5. AWS에 FastAPI 애플리케이션 배포하기

AWS에 FastAPI 애플리케이션을 배포하기 위해 여러 가지 방법이 있지만, 여기서는 Amazon EC2를 이용한 방법을 설명하겠습니다.

5.1. EC2 인스턴스 생성하기

AWS Management Console에 로그인 후, EC2 대시보드로 이동하여 새로운 인스턴스를 생성합니다. 여기서는 Amazon Linux 2 AMI를 사용하는 것이 일반적입니다.

5.2. 인스턴스 SSH로 접속하기

인스턴스를 생성한 후, SSH를 이용해 접속할 수 있습니다. 아래의 명령어를 사용합니다:

ssh -i your_key.pem ec2-user@your_instance_public_ip
    

5.3. FastAPI 및 필요한 패키지 설치하기

SSH로 접속한 후, 아래 명령어로 FastAPI와 uvicorn을 설치합니다:

sudo yum update -y
sudo yum install python3 -y
pip3 install fastapi uvicorn
    

5.4. FastAPI 서버 실행하기

이제 FastAPI 애플리케이션을 실행할 차례입니다. 새 프로젝트 디렉토리를 만들고, 앞서 만든 main.py 파일을 업로드합니다:

mkdir fastapi-app
cd fastapi-app
# 파일 전송: scp -i your_key.pem main.py ec2-user@your_instance_public_ip:~/fastapi-app/
uvicorn main:app --host 0.0.0.0 --port 8000
    

5.5. AWS Security Group 설정하기

FastAPI 서버가 외부에서 접근 가능하려면, EC2 인스턴스의 Security Group settings에서 포트 8000을 열어줘야 합니다. 다음 단계를 따라주세요:

1. AWS Management Console에서 EC2 대시보드로 이동합니다.
2. 좌측 메뉴에서 “Security Groups”를 클릭합니다.
3. 인스턴스와 연결된 Security Group을 선택합니다.
4. “Inbound rules” 탭에서 “Edit inbound rules”를 클릭하여 포트 8000을 추가합니다.

5.6. FastAPI 애플리케이션에 접근하기

이제 웹 브라우저를 열고 `http://your_instance_public_ip:8000`를 입력하여 FastAPI 애플리케이션에 접근할 수 있습니다.

6. 추가적인 배포 방법

AWS EC2 외에도 FastAPI 애플리케이션을 배포할 수 있는 다른 방법들이 있습니다:

• AWS Elastic Beanstalk: 복잡한 서버 설정이 필요 없이 웹 애플리케이션을 관리할 수 있습니다.
• AWS Lambda: 서버리스 아키텍처를 사용하여 비용 효율적으로 애플리케이션을 운영할 수 있습니다.
• Docker: Docker를 사용하여 컨테이너화된 FastAPI 애플리케이션을 배포할 수 있습니다.

7. 마치며

FastAPI는 강력하고 사용하기 쉬운 프레임워크로, 특히 비동기 프로그래밍에 적합합니다. AWS에 배포하는 과정은 조금 복잡할 수 있지만, AWS의 다양한 도구를 활용하여 배포를 쉽게 할 수 있습니다. 앞으로 FastAPI와 함께 멋진 웹 애플리케이션을 만들어 보세요!

이 글이 FastAPI와 AWS 배포에 대한 이해를 돕는 데 유용했기를 바랍니다. 더 많은 정보와 예제 코드가 필요하시면, GitHub에서 FastAPI 공식 문서를 참조해보세요.

FastAPI는 현대적인 웹 프레임워크 중 하나로, Python으로 API를 손쉽게 만들 수 있도록 돕습니다. 비동기 처리를 지원하며 높은 성능을 자랑하는 FastAPI는 RESTful API 개발에 최적화되어 있습니다. 이 글에서는 FastAPI를 사용한 서버 개발 주제로 CRUD(Create, Read, Update, Delete) 연산 중 ‘Delete’ 작업에 대해 다루어 보겠습니다.

1. FastAPI 소개

FastAPI는 Starlette와 Pydantic을 기반으로 하며, OpenAPI와 JSON Schema를 지원하여 사용자와의 상호작용을 더욱 매끄럽게 해줍니다. Python 타입 힌트와 문서화 기능 덕분에, 개발자는 오류를 줄이고 빠르게 개발할 수 있습니다.

1.1 FastAPI 특징

• 비동기 지원
• 자동 문서화
• 높은 성능
• 유형 기반 데이터 검증
• 간단한 라우팅

2. 환경 설정

이 프로젝트에서는 FastAPI와 SQLAlchemy를 사용하여 데이터베이스와의 상호작용을 구현합니다. 아래의 과정을 통해 FastAPI 환경을 설정해보겠습니다.

2.1 FastAPI 및 필요한 패키지 설치

FastAPI와 SQLAlchemy를 설치하기 위해서는 먼저 pip를 사용합니다. 아래의 명령어를 실행하여 설치합니다.

pip install fastapi[all] sqlalchemy

2.2 프로젝트 구조 설정

아래와 같은 기본적인 디렉터리 구조를 설정합니다.

my_fastapi_app/
│
├── app/
│   ├── main.py
│   ├── models.py
│   ├── schemas.py
│   └── database.py
└── requirements.txt
    

3. 데이터베이스 설정

아래는 SQLAlchemy를 사용하여 SQLite 데이터베이스를 설정하는 예제입니다.

3.1 database.py

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

SQLALCHEMY_DATABASE_URL = "sqlite:///./test.db"

engine = create_engine(SQLALCHEMY_DATABASE_URL, connect_args={"check_same_thread": False})
SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)

Base = declarative_base()
    

3.2 모델 정의하기

데이터베이스와 상호작용하기 위한 모델을 정의합니다.

3.2.1 models.py

from sqlalchemy import Column, Integer, String
from .database import Base

class Item(Base):
    __tablename__ = "items"

    id = Column(Integer, primary_key=True, index=True)
    name = Column(String, index=True)
    description = Column(String, index=True)
    price = Column(Integer)
    is_active = Column(Boolean, default=True)
    

4. 데이터 조작

이제 삭제 작업을 포함한 CRUD 연산을 구현할 수 있도록 API 엔드포인트를 생성하겠습니다.

4.1 스키마 정의하기

API 요청과 응답을 정의하기 위해 Pydantic을 사용하여 스키마를 만듭니다.

4.1.1 schemas.py

from pydantic import BaseModel

class ItemBase(BaseModel):
    name: str
    description: str
    price: int

class ItemCreate(ItemBase):
    pass

class Item(ItemBase):
    id: int
    is_active: bool

    class Config:
        orm_mode = True
    

4.2 CRUD 연산 구현

이제 FastAPI와 SQLAlchemy를 통합하여 CRUD 연산을 구현하겠습니다.

4.2.1 main.py

from fastapi import FastAPI, Depends, HTTPException
from sqlalchemy.orm import Session
from . import models, schemas
from .database import SessionLocal, engine

models.Base.metadata.create_all(bind=engine)

app = FastAPI()

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

@app.delete("/items/{item_id}", response_model=schemas.Item)
def delete_item(item_id: int, db: Session = Depends(get_db)):
    item = db.query(models.Item).filter(models.Item.id == item_id).first()
    if not item:
        raise HTTPException(status_code=404, detail="Item not found")
    db.delete(item)
    db.commit()
    return item
    

5. 설명 및 사용

위의 코드에서 /items/{item_id} 경로로 DELETE 요청을 보내면 해당 ID를 가진 아이템이 데이터베이스에서 삭제됩니다. 만약 아이템이 존재하지 않으면 404 Not Found 오류가 발생합니다.

5.1 사용 예시

Postman과 같은 API 클라이언트를 사용하여 요청을 테스트할 수 있습니다. 예를 들어, 다음과 같은 DELETE 요청을 보낼 수 있습니다:

DELETE http://127.0.0.1:8000/items/1
    

5.2 결과 확인하기

DELETE 요청이 성공적으로 처리되면, 해당 아이템의 데이터가 삭제되며, 삭제된 아이템의 정보가 응답으로 반환됩니다.

6. 결론

이 글에서는 FastAPI를 사용하여 Delete 연산을 구현하는 방법을 배웠습니다. FastAPI는 Python으로 API를 개발할 때 매우 유용한 도구이며, 데이터베이스와의 상호작용을 통해 유연한 서비스를 제공할 수 있습니다. CRUD 연산의 기본적인 사용법을 익혔다면, 실제 비즈니스 로직을 구현하는 데 더 나아갈 수 있을 것입니다.

7. 참고 문헌

• FastAPI 공식 문서
• SQLAlchemy 공식 문서

현대 웹 애플리케이션에서 사용자 인증 및 보안을 확보하는 것은 매우 중요한 문제입니다. 특히, 비밀번호와 같은 민감한 정보는 적절하게 보호되어야 합니다. 이를 위해 우리는 FastAPI를 사용하여 백엔드 서버를 개발하고, 비밀번호 해싱을 통해 사용자 비밀번호를 안전하게 저장하는 방법을 알아보겠습니다.

1. FastAPI 소개

FastAPI는 Python으로 작성된 현대적인 웹 프레임워크로, 비동기 프로그래밍을 지원하고, OpenAPI 및 JSON Schema를 자동으로 생성할 수 있습니다. 성능이 뛰어나며, 신속한 프로토타이핑과 설계 검증에 적합합니다. FastAPI는 RESTful API 개발을 위한 매우 직관적이고 간편한 접근 방식을 제공합니다.

2. 패스워드 해싱이란?

패스워드 해싱은 사용자가 입력한 비밀번호를 해시 함수를 통해 변형해 저장하는 작업입니다. 이를 통해 비밀번호가 노출되더라도 원래 비밀번호를 알아낼 수 없도록 방지할 수 있습니다. 해싱 알고리즘으로는 BCrypt, Argon2, PBKDF2 등이 있으며, 이들 각각은 복잡성과 보안 수준이 다릅니다.

2.1 해싱 알고리즘

비밀번호 해싱에서 가장 널리 사용되는 알고리즘은 다음과 같습니다:

• BCrypt: 비밀번호를 해싱할 때 적절한 비용 인자를 사용하여 보안을 강화하는 알고리즘입니다.
• Argon2: 2015년 패스워드 해싱 대회에서 우승한 알고리즘으로, 메모리 요구 사항을 증가시켜 공격에 대한 저항력을 높입니다.
• PBKDF2: 반복적 해싱을 통해 비밀번호의 복잡성을 높이는 알고리즘으로, 일정량의 시간과 메모리를 소모하도록 설계되었습니다.

3. FastAPI 환경 구축

이제 FastAPI 프로젝트를 설정하고 비밀번호를 안전하게 해싱하기 위한 준비를 해보겠습니다.

3.1 FastAPI 설치

FastAPI 및 해싱을 위한 필요한 라이브러리를 설치합니다. 다음 명령어를 실행하여 필요한 패키지를 설치합니다:

pip install fastapi uvicorn passlib[bcrypt]

3.2 프로젝트 구조

다음과 같은 디렉토리 구조를 생성합니다:

project/
│
├── app/
│   ├── __init__.py
│   ├── main.py
│   └── models.py
└── requirements.txt
    

3.3 기본 FastAPI 앱 작성

이제 FastAPI 애플리케이션을 작성해보겠습니다. main.py 파일에 기본 API를 설정합니다.

from fastapi import FastAPI
from pydantic import BaseModel
from passlib.context import CryptContext

app = FastAPI()
pwd_context = CryptContext(schemes=["bcrypt"], deprecated="auto")

# 사용자 모델 정의
class User(BaseModel):
    username: str
    password: str

# 비밀번호 해싱 함수
def hash_password(password: str) -> str:
    return pwd_context.hash(password)

# 사용자 등록 엔드포인트
@app.post("/register/")
async def register(user: User):
    hashed_password = hash_password(user.password)
    return {"username": user.username, "hashed_password": hashed_password}
    

4. 비밀번호 해싱 구현

위 코드에서는 비밀번호 해싱을 위한 간단한 FastAPI 애플리케이션을 작성하였습니다. 이 애플리케이션은 사용자가 등록할 때 비밀번호를 해싱하여 반환합니다.

4.1 비밀번호 해싱 과정 설명

• 사용자가 등록하면, register 엔드포인트가 호출됩니다.
• 입력받은 비밀번호는 hash_password 함수를 통해 해싱됩니다.
• 해싱된 비밀번호는 JSON 응답으로 반환됩니다.

5. 서버 실행하기

FastAPI 서버를 실행하기 위해 터미널에서 다음 명령어를 입력합니다:

uvicorn app.main:app --reload

서버가 성공적으로 실행되면, http://127.0.0.1:8000/docs를 방문하여 Swagger UI에서 API를 테스트할 수 있습니다.

6. 비밀번호 검증

사용자가 로그인하면, 입력한 비밀번호와 DB에 저장된 해싱된 비밀번호를 비교해야 합니다. 이를 위해 비밀번호 검증 함수를 추가해 보겠습니다.

# 비밀번호 검증 함수
def verify_password(plain_password: str, hashed_password: str) -> bool:
    return pwd_context.verify(plain_password, hashed_password)

@app.post("/login/")
async def login(user: User):
    # 비밀번호 검증 로직 (여기서는 간단히 하드코딩)
    stored_hashed_password = "$2b$12$KixR7Pq2B7lZq5NOsx.xreOS5Jz4P3qv1E8pF8ozFpXZKLaMvvWry"  # 예시 해시
    if verify_password(user.password, stored_hashed_password):
        return {"message": f"Welcome {user.username}"}
    else:
        return {"message": "Invalid credentials"}
    

7. 결론

이번 글에서는 FastAPI로 간단한 백엔드 서버를 구성하고 패스워드 해싱 기능을 추가하는 방법을 배웠습니다. 비밀번호는 해싱을 통해 저장함으로써 사용자의 정보를 안전하게 보호할 수 있습니다. 본 예제는 간단한 형태이므로, 실제 서비스에서는 데이터베이스와의 연동, 에러 처리, 유효성 검증 등 추가적인 로직이 필요합니다.

8. 추가 자료

FastAPI 및 패스워드 해싱 관련 추가 자료를 아래와 같이 추천합니다:

• FastAPI 공식 문서
• Passlib 공식 문서
• Cryptography 라이브러리

FastAPI를 통해 성능 좋고 안전한 웹 API를 구축해 보세요!

FastAPI는 최신 웹 프레임워크로, 비동기 프로그래밍과 타입 힌트를 지원하여 빠른 성능과 개발 편의성을 제공합니다. 본 강좌에서는 FastAPI를 사용한 서버 개발의 기초부터 Jinja2를 사용한 템플릿 렌더링, 그리고 매크로를 사용한 템플릿의 재사용성 향상까지 알아보겠습니다.

1. FastAPI 소개

FastAPI는 Python으로 작성된 현대적인 웹 프레임워크로, 다음과 같은 특징이 있습니다:

• 신속한 개발
• 자동 문서화
• 비동기 요청 처리
• 타입 검사

FastAPI는 Starlette 프레임워크를 기반으로 하며, Pydantic을 통해 데이터 유효성 검사를 수행합니다. 이러한 특성 덕분에 FastAPI는 RESTful API 개발에 매우 적합합니다.

2. 개발 환경 설정

FastAPI를 사용하기 위해 먼저 Python과 FastAPI를 설치해야 합니다. 아래 명령어로 설치할 수 있습니다:

pip install fastapi uvicorn

추가로 Jinja2 템플릿 엔진도 설치해야 합니다:

pip install jinja2

3. FastAPI 기본 예제

다음은 간단한 FastAPI 서버 예제입니다. 이 서버는 기본적인 GET 및 POST 요청을 처리합니다.

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

# 데이터 모델 정의
class Item(BaseModel):
    name: str
    price: float
    is_offer: bool = None

# GET 요청 처리
@app.get("/")
async def read_root():
    return {"Hello": "World"}

# POST 요청 처리
@app.post("/items/")
async def create_item(item: Item):
    return item

위 코드를 사용하여 FastAPI 서버를 실행하려면, 다음 명령어를 입력합니다:

uvicorn main:app --reload

이제 localhost:8000에서 서버가 실행되고 있습니다.

4. Jinja2 템플릿 엔진

Jinja2는 Python으로 작성된 템플릿 엔진으로, 파이썬 코드를 HTML 문서에 쉽게 삽입할 수 있도록 해줍니다. FastAPI와 Jinja2를 결합하면 동적인 웹 페이지를 만들 수 있습니다.

4.1 Jinja2 설치

Jinja2는 이미 설치한 상태로 가정하겠습니다. 만약 설치하지 않았다면, 이전 단락의 명령어를 통해 설치하시면 됩니다.

4.2 Jinja2 템플릿 설정

FastAPI와 Jinja2를 연동하기 위해, 다음과 같은 디렉토리 구조를 설정합니다:

project/
│
├── main.py
└── templates/
    └── index.html

이제 index.html 파일을 작성해보겠습니다:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>FastAPI & Jinja2</title>
</head>
<body>
    <h1>환영합니다!</h1>
    <p>여기는 FastAPI와 Jinja2로 작성된 웹 페이지입니다.</p>
    <ul>
    {% for item in items %}
        <li>{{ item.name }}: ${{ item.price }}{% if item.is_offer %} (할인 중){% endif %}</li>
    {% endfor %}
    </ul>
</body>
</html>

4.3 FastAPI에서 Jinja2 템플릿 사용하기

이제 FastAPI에서 Jinja2를 사용하여 템플릿을 렌더링할 수 있습니다. 다음과 같은 코드를 main.py에 추가합니다:

from fastapi import FastAPI, Request
from fastapi.responses import HTMLResponse
from fastapi.templating import Jinja2Templates

templates = Jinja2Templates(directory="templates")

@app.get("/items/", response_class=HTMLResponse)
async def read_items(request: Request):
    items = [{"name": "Item 1", "price": 10.5, "is_offer": True},
             {"name": "Item 2", "price": 20.5, "is_offer": False}]
    return templates.TemplateResponse("index.html", {"request": request, "items": items})

이제 localhost:8000/items/로 이동하면, Jinja2 템플릿을 통해 렌더링된 HTML 페이지를 확인할 수 있습니다.

5. Jinja2 매크로 사용하기

매크로는 Jinja2의 강력한 기능으로, 템플릿 내에서 코드의 재사용성을 높여줍니다. 매크로를 사용하면 반복되는 코드 패턴을 간편하게 정의하고 재사용할 수 있습니다.

5.1 매크로 정의

먼저 index.html 파일에 매크로를 추가해보겠습니다.

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>FastAPI & Jinja2</title>
</head>
<body>
    <h1>환영합니다!</h1>

    <!-- 매크로 정의 -->
    <{% macro render_item(item) %}>
        <li>{{ item.name }}: ${{ item.price }}{% if item.is_offer %} (할인 중){% endif %}</li>
    <{% endmacro %}>

    <ul>
    {% for item in items %}
        {{ render_item(item) }}
    {% endfor %}
    </ul>
</body>
</html>

5.2 매크로 사용하기

이제 매크로를 정의했으므로, render_item 매크로를 호출하여 각 아이템을 렌더링할 수 있습니다. 앞서 작성했던 read_items 함수는 그대로 유지됩니다.

이렇게 작성한 후, localhost:8000/items/에 접속하면 매크로를 통해 렌더링된 결과를 확인할 수 있습니다.

6. 마치며

이번 강좌에서는 FastAPI를 사용한 웹 서버 개발 방법과 Jinja2 템플릿 엔진 사용법, 그리고 매크로를 통한 코드 재사용성을 높이는 방법에 대해 알아보았습니다. FastAPI는 성능뿐만 아니라 생산성을 높여주는 훌륭한 도구입니다. 이를 통해 여러분의 웹 애플리케이션을 더욱 빠르고 효율적으로 개발할 수 있기를 바랍니다.

추가적으로 FastAPI와 Jinja2에 대한 더 많은 예제 및 유용한 자료는 공식 문서에서 확인하실 수 있습니다.

참고 자료

• FastAPI 공식 문서
• Jinja2 공식 문서

FastAPI는 현대적인 웹 애플리케이션을 구축하기 위한 높은 성능을 자랑하는 Python 웹 프레임워크입니다. FastAPI의 가장 큰 장점 중 하나는
자동화된 API 문서화인데, 이는 개발자들이 API를 쉽게 이해하고 사용할 수 있도록 해줍니다. 이 글에서는 FastAPI의 문서화 기능과 그 사용 방법에 대해
자세히 설명하겠습니다.

FastAPI 소개

FastAPI는 Starlette를 기반으로 하여 만들어진 프레임워크로, asyncio를 지원하여 비동기적인 요청 처리가 가능하며, 매우 높은 성능을 자랑합니다.
FastAPI는 데이터 검증, 직렬화, 문서화 등의 기능을 쉽게 구현할 수 있도록 도와줍니다. 또한, FastAPI를 사용하면 Python 타입 힌트를 활용하여 API의 입력 및 출력
모델을 정의하고, 이를 기반으로 자동으로 문서를 생성할 수 있습니다.

FastAPI의 기본적인 사용법

FastAPI를 사용하기 위해서는 먼저 FastAPI 라이브러리를 설치해야 합니다. 아래와 같은 명령어로 설치할 수 있습니다:

pip install fastapi[all]

FastAPI의 기본적인 사용법을 알아보겠습니다. 아래는 아주 간단한 FastAPI 앱의 예시입니다.

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def read_root():
    return {"Hello": "World"}

위의 코드에서 FastAPI() 인스턴스를 생성하고, @app.get("/")를 사용하여 루트 경로에 대한 GET 요청을 처리하는
read_root 함수를 정의했습니다. FastAPI는 이 함수를 호출할 때 자동으로 JSON 응답을 반환합니다.

FastAPI의 자동 문서화 기능

FastAPI의 자동 문서화 기능은 기본적으로 Swagger UI와 ReDoc을 제공합니다. FastAPI 앱이 실행되는 동안 다음 URL에서 문서화된 API를 확인할 수 있습니다:

• Swagger UI: http:///docs
• ReDoc: http:///redoc

FastAPI는 각 엔드포인트에 대한 문서를 자동으로 생성하며, Swagger UI는 이를 시각적으로 표현합니다.
문서를 구성하는 데 있어서 FastAPI의 장점은 Python 타입 힌트를 이용해 API의 요청 및 응답 모델을 정의할 수 있다는 점입니다.

요청 및 응답 모델 정의

FastAPI에서는 Pydantic을 사용하여 데이터 모델을 정의할 수 있습니다. Pydantic은 데이터 검증과 설정을 위한 데이터 클래스와 검증 기능을 제공합니다.
요청 및 응답 모델을 정의하면 FastAPI는 이를 이용해 자동으로 문서를 생성합니다. 아래는 요청 모델과 응답 모델을 사용하는 예제입니다.

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

class Item(BaseModel):
    name: str
    description: str = None
    price: float
    tax: float = None

@app.post("/items/", response_model=Item)
def create_item(item: Item):
    return item

위의 코드에서 Item 클래스를 정의하여 요청 모델을 만들었습니다. 이 클래스는 BaseModel을 상속하며
각 필드에 대한 데이터 타입을 정의합니다. @app.post("/items/")를 사용하여 POST 요청을 처리하는
create_item 함수를 정의하고, 이 함수는 요청에서 Item 모델을 인자로 받습니다. 또한, 응답 모델로도 같은
Item 클래스를 사용하고 있습니다.

FastAPI에서의 문서화 항목 설명

FastAPI 자동 문서화에는 몇 가지 유용한 기능이 포함되어 있습니다. 이 섹션에서는 몇 가지 주요 기능에 대해 살펴보겠습니다.

요청 본문 설명

FastAPI는 Pydantic의 모델을 사용하여 API 요청의 본문을 설명합니다. 위의 예제에서는 Item 모델이 요청 본문에 대한
구조를 설명하므로, Swagger UI에서 해당 요청의 구조를 쉽게 이해할 수 있습니다.

쿼리 매개변수 설명

FastAPI는 쿼리 매개변수에 대한 설명도 추가할 수 있습니다. 예를 들어, 아래와 같이 쿼리 매개변수를 사용하는 API를 만들어 보겠습니다.

@app.get("/items/")
def read_items(skip: int = 0, limit: int = 10):
    return {"skip": skip, "limit": limit}

위의 코드에서 skip와 limit 매개변수를 정의하였고, 기본값을 설정했습니다. FastAPI는 이 정보에 기반하여
Swagger UI에서 쿼리 매개변수에 대한 설명을 제공합니다.

답변 설명 추가

FastAPI는 응답 타입에 대한 설명도 추가할 수 있습니다. 응답 모델을 정의할 때 response_model 매개변수를 사용하여
명확하게 응답의 구조를 설명할 수 있습니다.

FastAPI 사용자 지정 문서화

기본적으로 FastAPI는 Swagger와 ReDoc을 사용하여 자동 문서화를 제공합니다. 그러나 때때로 사용자 지정 내용을 추가하고 싶을 수 있습니다.
FastAPI는 엔드포인트에 대한 설명 및 태그를 사용자 지정할 수 있는 방법을 제공합니다.

엔드포인트에 대한 설명 추가

FastAPI의 경로에 대한 설명과 설명을 추가할 수 있습니다. 아래는 이를 보여주는 예제입니다.

@app.get("/items/", tags=["items"], summary="Get items", description="Retrieve a list of items based on skip and limit")
def read_items(skip: int = 0, limit: int = 10):
    return {"skip": skip, "limit": limit}

위의 코드에서 tags, summary, 및 description 매개변수를 사용하여 Swagger UI에서
더 나은 설명을 제공합니다. 이는 다른 개발자들이 API를 이해하는 데 큰 도움이 됩니다.

결론

FastAPI는 Python 기반의 API 서버를 쉽고 빠르게 구축할 수 있게 해주는 프레임워크입니다. 자동 문서화 기능을 통해 Swagger UI 및
ReDoc을 제공하여 API의 사용을 훨씬 간편하게 만들어 줍니다. Pydantic을 활용하여 데이터 모델을 정의하고, 이를 기반으로
요청 및 응답을 담당하는 API를 작성할 수 있습니다. 사용자 지정 문서화 기능을 통해 더 나은 API 문서를 작성할 수 있으며, 다른
개발자들과의 협업을 용이하게 할 수 있습니다.

FastAPI의 이러한 특성 덕분에 빠르고 효율적인 백엔드 서버 개발이 가능합니다. 이는 특히 데이터 중심의 애플리케이션을 개발할
때 큰 장점을 제공합니다.