Routing und Artikelliste & Detailseite
In diesem Kapitel lernst du, APIRouter zum Aufteilen von Routen zu verwenden und die Artikelliste der Startseite sowie die Artikeldetailseite zu implementieren.
APIRouter — FastAPIs Lösung zum Aufteilen von Routen
APIRouter ist analog zu Flasks Blueprint und Djangos include().
Beispiel
from fastapi import APIRouter, Depends, HTTPException, Anfrage
from sqlalchemy.orm import Session
from database import get_db
from models import Post, Category
from schemas import PostResponse
router = APIRouter(
prefix="/posts", # Alle Routen haben automatisch das Präfix /posts
tags=["Article"] # Tags in der Swagger-Dokumentation gruppieren
)
@router.get("/{post_id}", response_model=PostResponse, name="post_detail")
def post_detail(post_id: int, db: Session = Depends(get_db)):
"""Artikeldetail (JSON API)"""
post = db.query(Post).filter(Post.id == post_id).first()
if not post:
raise HTTPException(status_code=404, detail=“Artikel existiert nicht”)
return post
APIRouter in main.py einbinden:
Beispiel
from routers.categories import router as categories_router
app.include_router(posts_router)
app.include_router(categories_router)
Artikelliste-Seite rendern
Beispiel
from fastapi import APIRouter, Depends, Request, Abfrage
from fastapi.templating import Jinja2Templates
from sqlalchemy.orm import Session
from database import get_db
from models import Post, Category
router = APIRouter()
templates = Jinja2Templates(directory="templates")
@router.get("/", name="index")
def index(
request: Request,
category: str | None = Query(None), # Abfrageparameter: optional
db: Session = Depends(get_db)
):
"""Startseite: Artikelliste + Kategoriefilter"""
# Basisabfrage
posts_query = db.query(Post).order_by(Post.created_at.desc())
# Kategoriefilter
if category:
posts_query = posts_query.join(Category).filter(Category.slug == category)
posts = posts_query.all()
categories = db.query(Category).all()
return templates.TemplateResponse("index.html", {
"request": request,
"posts": posts,
"categories": categories,
"category_slug": category or ""
})
str | None = Query(None)Dies ist die Typ-Union-Syntax von Python 3.10+, äquivalent zuOptional[str]. FastAPI wird automatisch, basierend auf Typ-Hinweisen: 1. den Parameter optional machen; 2. ihn in den Swagger-Dokumenten als optional markieren; 3. keinen Fehler auslösen, wenn er nicht angegeben wird.
Artikeldetailseite rendern
Beispiel
@router.get("/post/{post_id}", name="post_detail")
def post_detail(request: Request, post_id: int, db: Session = Depends(get_db)):
"""Artikeldetailseite"""
post = db.query(Post).filter(Post.id == post_id).first()
if not post:
raise HTTPException(status_code=404, detail=“Artikel existiert nicht”)
return templates.TemplateResponse("post_detail.html", {
"request": request,
"post": post
})
Beachten Sie den Unterschied: Dieselbe Route kann sowohl eine JSON-API (mit Angabe von response_model) als auch eine HTML-Seite (die TemplateResponse zurückgibt) bereitstellen. Die übliche Praxis ist: API-Routen werden unter dem Präfix /api/ platziert, während Seitenrouten im Stammverzeichnis platziert werden.
Vorlagen für Startseite und Detailseite erstellen
Beispiel
{% extends 'base.html' %}
{% block title %}EXAMPLE Blog - Startseite{% endblock %}
{% block content %}
<h2 class="section-title">Neueste Artikel</h2>
<div class="category-bar">
<a href="/" class="{% if not category_slug %}active{% endif %}">Alle</a>
{% for cat in categories %}
<a href="/?category={{ cat.slug }}"
class="{% if category_slug == cat.slug %}active{% endif %}">
{{ cat.name }}
</a>
{% endfor %}
</div>
{% if posts %}
<div class="article-grid">
{% for post in posts %}
<a href="/post/{{ post.id }}" class="card-link">
<div class="article-card">
<div class="card-content">
<span class="card-category">{{ post.category.name }}</span>
<h3>{{ post.title }}</h3>
<p>{{ post.summary|truncate(80) }}</p>
<span class="card-date">{{ post.created_at.strftime('%Y-%m-%d') }}</span>
</div>
</div>
</a>
{% endfor %}
</div>
{% else %}
<p class="empty-tip">Noch keine Artikel in dieser Kategorie.</p>
{% endif %}
{% endblock %}
Beispiel
{% extends 'base.html' %}
{% block title %}{{ post.title }} - BEISPIEL Blog{% endblock %}
{% block content %}
<article class="post-view">
<span class="category-tag">{{ post.category.name }}</span>
<h1>{{ post.title }}</h1>
<time>{{ post.created_at.strftime('%Y-%m-%d') }}</time>
<div class="content">{{ post.content|safe }}</div>
<a href="/" class="back-link">← Zurück zur Startseite</a>
</article>
{% endblock %}
Kapitelzusammenfassung
In diesem Kapitel hast du die Kern-Routing-Entwicklung von FastAPI abgeschlossen: APIRouter teilt Routen nach Modulen auf (Prefix + Tags), Abfrageparameter werden mit Query() + Typ-Hinweisen deklariert, TemplateResponse rendert Seiten und die Behandlung von 404-Ausnahmen.
Der Blog hat jetzt drei vollständige Seiten: die Artikelliste der Startseite, die Kategoriefilterung und die Detailseite.
Weitere Erweiterungen