프로젝트/Python - FastAPI

[Python_FastAPI] TodoList#1, 파이썬 FastAPI로 html 렌더링(연결)

CBJH 2024. 5. 2. 16:18
728x90
반응형

※ 요약

  • 파이썬 fastAPI로 get방식을 이용해 html 파일을 렌더링하는 예제입니다.
  • http://127.0.0.1:8000/list에 "Hello, Python!"을 출력합니다.

 

 

 

FastAPI를 사용하여 HTML 템플릿을 렌더링하는 예제를 만드는 과정은 다음과 같습니다. 여기서는 FastAPI와 함께 Jinja2 템플릿 엔진을 사용하여 list.html 템플릿을 렌더링할 것입니다. 먼저 필요한 패키지를 설치해야 합니다.

1. 필요한 패키지 설치

FastAPI와 uvicorn (ASGI 서버), 그리고 jinja2를 설치합니다. 터미널에서 다음 명령어를 실행하세요:

pip install fastapi uvicorn jinja2

2. main.py 파일 생성

main.py 파일을 만들고 아래 코드를 작성합니다. 이 코드는 FastAPI 애플리케이션을 설정하고, Jinja2 템플릿을 렌더링하는 엔드포인트를 포함합니다.

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

app = FastAPI()
templates = Jinja2Templates(directory="templates")

@app.get("/list")
async def get_list(request: Request):
    return templates.TemplateResponse("list.html", {"request": request})
  • 상위 폴더에 템플릿 디렉토리가 있는 경우:
    • 상위 폴더에 있는 템플릿 디렉토리를 지정하기 위해서는 경로 앞에 "../"를 추가하여 상위 디렉토리를 참조하게 합니다. 예를 들어, 현재 Python 스크립트 파일이 app/main.py 위치해 있고, 템플릿 디렉토리가 templates/ 폴더 내에 있으며 이 폴더가 app/의 상위 디렉토리에 위치한 경우, 다음과 같이 지정할 수 있습니다:
    • templates = Jinja2Templates(directory="../templates")

3. templates/list.html 파일 생성

templates 폴더를 생성하고 그 안에 list.html 파일을 만든 후, 다음 HTML 코드를 입력합니다:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>My List</title>
</head>
<body>
    <h1>Hello, Python!</h1>
</body>
</html>

4. 애플리케이션 실행

애플리케이션을 실행하기 위해 터미널에서 다음 명령어를 사용합니다:

uvicorn main:app --reload

--reload 옵션은 개발 중 파일 변경을 자동으로 감지하고 서버를 재시작합니다.

5. 웹 브라우저에서 확인

웹 브라우저를 열고 http://127.0.0.1:8000/list 주소로 접속하면 Hello, Python!이 표시된 list.html 페이지를 볼 수 있습니다.

이렇게 하면 FastAPI를 사용하여 HTML 템플릿을 렌더링하는 기본적인 설정과 실행이 완료됩니다. FastAPI의 강력한 기능을 활용하여 복잡한 웹 애플리케이션도 구축할 수 있습니다.

 

 

 

※ 추가로 알아둘 것들

 

* Uvicorn

Uvicorn은 Python에서 사용하는 ASGI (Asynchronous Server Gateway Interface) 호환 웹 서버입니다. ASGI는 WSGI (Web Server Gateway Interface)의 비동기 버전으로, Python 웹 프레임워크들이 비동기 기능을 사용하여 보다 효율적으로 동작할 수 있게 설계되었습니다.

Uvicorn의 주요 특징:

  1. 비동기성: Uvicorn은 비동기 프로그래밍을 지원하는 Python의 asyncio 라이브러리를 기반으로 구축되어 있어, 동시에 여러 네트워크 연결을 효율적으로 처리할 수 있습니다.
  2. 성능: 비동기 코드는 쓰레드나 프로세스 기반의 코드보다 효율적인 경우가 많기 때문에, Uvicorn은 높은 동시성 상황에서 빠른 성능을 제공합니다.
  3. 간단하고 쉬운 사용법: 단순하면서도 강력한 API를 제공하여, 사용자가 쉽게 웹 서버를 설정하고 실행할 수 있게 해줍니다.
  4. 표준 호환성: ASGI는 최신 Python 비동기 웹 프레임워크들과 호환되므로, Uvicorn은 Starlette, FastAPI 등과 같은 여러 프레임워크에서 사용될 수 있습니다.

Uvicorn은 특히 FastAPI와 같은 비동기 프레임워크와 함께 사용될 때 그 진가를 발휘합니다. FastAPI를 사용할 때, Uvicorn은 일반적으로 개발 서버로서 추천되며, 프로덕션 환경에서도 뛰어난 성능을 제공합니다.

 

* Jinja2

Jinja2는 Python의 가장 인기 있는 템플릿 엔진 중 하나입니다. Flask, Django 등 다양한 웹 프레임워크와 함께 사용되며, 웹 페이지의 HTML을 동적으로 생성할 때 사용됩니다.

Jinja2의 주요 특징:

  1. 템플릿 상속: Jinja2는 템플릿 상속을 지원하여, 웹 개발자들이 기본 레이아웃을 정의하고 그 레이아웃을 여러 페이지에 걸쳐 재사용할 수 있게 해줍니다. 이는 코드의 중복을 줄이고, 유지보수를 쉽게 합니다.
  2. 속도: Jinja2는 매우 빠르며, 컴파일된 템플릿을 메모리에 캐싱할 수 있어 반복적인 템플릿 렌더링을 최적화할 수 있습니다.
  3. 표현력 있는 언어: Jinja2의 템플릿 언어는 매우 표현력이 뛰어나 HTML 생성을 위한 로직을 쉽게 작성할 수 있습니다.
  4. 보안: 자동 HTML 이스케이프 기능을 통해 XSS (Cross Site Scripting) 공격을 방지할 수 있습니다.

Jinja2는 특히 웹 페이지에서 동적인 컨텐츠를 표시할 필요가 있을 때 유용합니다. 예를 들어, 사용자 정보를 기반으로 커스터마이즈된 페이지를 생성하거나, 서버에서 받은 데이터를 기반으로 다양한 HTML 요소를 조건부로 표시하고자 할 때 사용됩니다.

이 두 도구는 모두 Python 웹 개발의 중요한 구성 요소로, 웹 애플리케이션의 성능과 유지보수성, 보안을 크게 향상시키는 역할을 합니다.

댓글수0