FastAPI Archivos estáticos

FastAPI puede proporcionar fácilmente servicios de archivos estáticos (como imágenes, CSS, archivos JavaScript), usando laStaticFilesimplementación de Starlette.


Instalar dependencias

StaticFilesIncluido enaiofilesse necesita instalar:

pip install aiofiles

Montar el directorio de archivos estáticos

Usarapp.mount()para montar el directorio de archivos estáticos en la aplicación:

Ejemplo

from fastapi import FastAPI
from fastapi.staticfiles import StaticFiles

app = FastAPI()

# Montar el directorio de archivos estáticos
# "/static" es el prefijo de la ruta URL
# directory="static" es el nombre del directorio local
app.mount("/static", StaticFiles(directory="static"), name="static")


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

Explicación del código:

ParámetroDescripción
"/static"Prefijo de la ruta URL, por ejemplo, al acceder a/static/logo.png
directory="static"Nombre del directorio local, la carpeta donde se almacenan los archivos estáticos
name="static"Nombre utilizado internamente, para generar la URL (a través deurl_for)

mountes montar una "sub-aplicación" independiente en la ruta especificada.StaticFilesen sí mismo es una aplicación ASGI, que se encarga de manejar las solicitudes de archivos estáticos. Después de montarse, todas las solicitudes que/staticcomiencen conStaticFilesserán manejadas, sin pasar por el sistema de enrutamiento de FastAPI.


Ejemplo de estructura de directorios

project/
├── main.py
└── static/
    ├── css/
    │   └── style.css
    ├── js/
    │   └── app.js
    └── images/
        └── logo.png

Métodos de acceso:

Ruta del archivoURL
static/css/style.csshttp://127.0.0.1:8000/static/css/style.css
static/js/app.jshttp://127.0.0.1:8000/static/js/app.js
static/images/logo.pnghttp://127.0.0.1:8000/static/images/logo.png

Renderizado de plantillas HTML

FastAPI admite el motor de plantillas Jinja2, que puede renderizar dinámicamente páginas HTML:

Ejemplo

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

app = FastAPI()

# Archivos estáticos
app.mount(
    "/static",
    StaticFiles(directory="static"),
    name="static"
)

# Plantilla Jinja2
templates = Jinja2Templates(
    directory="templates"
)


@app.get("/hello/{name}")
async def hello(request: Request, name: str):
    return templates.TemplateResponse(
        request=request,
        name="hello.html",
        context={
            "name": name
        }
    )

Archivo de plantillatemplates/hello.html:

Ejemplo

<!DOCTYPE html>
<html>
<head>
    <title>Hello</title>
    <link rel="stylesheet" href="/static/css/style.css">
</head>
<body>
    <h1>Hello, {{ name }}!</h1>
    <img src="/static/images/logo.png" alt="Logo">
</body>
</html>

Al renderizar la plantilla, se debe pasar elrequestobjeto, porque en la plantilla puede que se necesite usar el contexto de la solicitud (como generar URL, etc.).


Resumen

  • UsarStaticFilespara proporcionar servicios de archivos estáticos
  • Usarapp.mount()para montar el directorio de archivos estáticos en la ruta especificada
  • Las rutas de archivos estáticos montadas no son administradas por el sistema de enrutamiento de FastAPI
  • Junto con el motor de plantillas Jinja2 se puede lograr el renderizado de páginas HTML
  • Los archivos estáticos son adecuados para almacenar recursos que no cambian dinámicamente, como CSS, JS, imágenes, etc.
Otras extensiones