Seminar FastAPI Professional: Architektur, Validierung und Dokumentation

Inhaltsverzeichnis

• Abstract
• Zielgruppe
• Voraussetzungen
• Dauer und Zeitaufteilung
• Lernziele
• Seminarstruktur und Inhalte
• Step-by-step-Anleitung: Modularisierte FastAPI-Anwendung
• Optionale Erweiterungen

Abstract
Das Professional-Seminar vertieft FastAPI für mittlere und größere Projekte. Im Fokus stehen Architektur, Modularisierung, Dependency Injection, erweiterte Validierung und saubere API-Dokumentation. Teilnehmende strukturieren eine Anwendung in mehrere Module und schaffen eine Basis für langfristig wartbare Backends.

Zielgruppe

• Erfahrene Python-Entwickler mit ersten FastAPI-Kenntnissen
• Lead-Developer, die FastAPI-Projekte strukturiert aufsetzen wollen
• Teams, die bestehende FastAPI-Anwendungen skalierbar machen müssen

Voraussetzungen

• Inhalte aus FastAPI Grundlagen: Einstieg in moderne Python-APIs oder vergleichbare FastAPI-Erfahrung
• Solide Python-Kenntnisse inklusive Typannotationen
• Grundverständnis zu REST-Design und HTTP

Agenda

Tag 1

• Modul 1: Projektarchitektur und Modularisierung
• Modul 2: Router, APIRouter, Versionierung
• Modul 3: Dependency Injection vertieft
• Modul 4: Konfiguration und Settings

Tag 2

• Modul 5: Komplexe Datenmodelle und Validierung
• Modul 6: Response-Modelle, Fehlerstrukturen, globale Handler
• Modul 7: API-Dokumentation strukturieren und anreichern
• Modul 8: Tagging, Beispiele, Reuse von Schemas

Tag 3

• Modul 9: API-Design-Richtlinien und Best Practices
• Modul 10: Refactoring eines Beispiels in modulare Struktur
• Modul 11: Abschlussprojekt mit Review

Lernziele

• Eine FastAPI-Anwendung in Module und Router aufteilen
• Dependency Injection für Konfiguration, Services und Repositories nutzen
• Komplexe Eingabe- und Ausgabe-Schemata modellieren
• Einheitliche Fehler- und Response-Strukturen etablieren
• Eine verständliche, gepflegte API-Dokumentation aufbauen

Seminarstruktur und Inhalte

• Architektur und Modularisierung
  • Layered Architecture und Domainorientierung
  • APIRouter und Sub-Apps
  • Versionierung von APIs
• Dependency Injection
  • Scoped Dependencies (Request, Application)
  • Konfiguration, Datenbankzugriffe, externe Services
• Datenmodelle und Validierung
  • Verschachtelte Modelle
  • Enums, Konvertierungen, Custom Validatoren
• Fehler- und Response-Design
  • Einheitliche Fehlerobjekte
  • Globale Exception-Handler
  • Logging-Grundlagen
• Dokumentation und DX
  • Gruppierung nach Tags
  • Beschreibungen, Beispiele, Schemas wiederverwenden
• Best Practices
  • Namenskonventionen, Projektstruktur
  • Umgang mit Breaking Changes

Step-by-step-Anleitung: Modularisierte FastAPI-Anwendung

• Analyse einer monolithischen main.py
  • Endpunkte, Datenmodelle und Datenzugriffe identifizieren
  • Verantwortlichkeiten grob bündeln
• Projektstruktur entwerfen
  • Ordner api, core, models, services anlegen
  • Schnittstellen zwischen den Paketen definieren
• Router aufsetzen
  • Router für einzelne Domänen (z. B. users, items) erstellen
  • Router in einer zentralen api/init.py registrieren
• Dependency Injection einsetzen
  • Konfigurationsobjekt als Dependency definieren
  • Services und Repositories mit Dependencies verknüpfen
• Fehlerbehandlung zentralisieren
  • Globale Exception-Handler definieren
  • Einheitliches Fehler-Response-Format implementieren
• Dokumentation verbessern
  • Tags für Router setzen
  • Endpunktbeschreibungen und Beispiele ergänzen
• Review und Refactoring
  • Zyklus aus Code-Review und Nachbesserung durchführen
  • Projektstruktur mit Designzielen abgleichen

Optionale Erweiterungen

• Einbindung eines API-Gateways im Architekturbild
• Erweiterung um Feature-Flags oder Konfigurationsprofile