Zum Inhalt

Backend-Entwicklungssetup

Diese Seite listet die Schritte auf, die erforderlich sind, um mit der Entwicklung der Gramps Web API, dem Backend (Serverkomponente) von Gramps Web, zu beginnen.

Voraussetzungen

Das empfohlene Entwicklungssetup verwendet Visual Studio Code mit Dev-Containern. Dieser Ansatz erstellt eine vorkonfigurierte Entwicklungsumgebung mit allen benötigten Tools. Um zu beginnen, benötigen Sie die folgenden Komponenten:

Sie können Linux, macOS oder Windows als Betriebssystem verwenden.

Erste Schritte

  1. Öffnen Sie das Gramps Web API-Repository und klicken Sie auf "fork".
  2. Klonen Sie Ihr geforktes Repository auf Ihren lokalen Computer mit Git.
  3. Öffnen Sie das geklonte Repository in Visual Studio Code. Wenn Sie dazu aufgefordert werden, wählen Sie "Reopen in Container" oder öffnen Sie manuell die Befehlspalette (Ctrl+Shift+P oder Cmd+Shift+P) und wählen Sie "Dev Containers: Rebuild and Reopen in Container".
  4. Warten Sie, bis der Dev-Container erstellt und gestartet wurde. Dies kann einige Minuten dauern, insbesondere beim ersten Mal.

Aufgaben

Wenn Sie nur den Backend-Code ändern, müssen Sie nicht unbedingt einen Webserver starten - Unit-Tests verwenden einen Flask-Testclient, der es ermöglicht, Anfragen an die API zu simulieren, ohne dass ein laufender Server erforderlich ist.

Das Ausführen eines Servers ist jedoch nützlich, wenn Sie

  • Ihre Änderungen mit echten HTTP-Anfragen ausprobieren möchten (siehe manuelle Abfragen),
  • die Auswirkungen von Änderungen auf die gesamte Gramps Web-Anwendung vorab anzeigen möchten oder
  • auch gleichzeitige Änderungen am Frontend vornehmen möchten (siehe Frontend-Entwicklungssetup).

Das Ausführen des Servers wird im Dev-Container durch vordefinierte Aufgaben vereinfacht. Sie können diese Aufgaben über die Befehlspalette (Ctrl+Shift+P oder Cmd+Shift+P) ausführen, indem Sie "Tasks: Run Task" auswählen und dann eine der folgenden Optionen wählen: - "Serve Web API" - startet den Flask-Entwicklungsserver auf Port 5555 mit aktivierter Debug-Protokollierung - "Start Celery worker" - startet einen Celery-Worker zur Verarbeitung von Hintergrundaufgaben.

Debugging

Debugging kann manchmal herausfordernd sein, insbesondere wenn es darum geht, komplexes Verhalten nachzuvollziehen oder subtile Probleme zu identifizieren. Um dies zu erleichtern, können Sie sowohl eine laufende API-Instanz als auch einzelne Testfälle direkt in Visual Studio Code debuggen.

Debugging der Gramps Web API

Um die laufende API zu debuggen:

  1. Öffnen Sie Visual Studio Code und gehen Sie zur Ansicht Run and Debug.
  2. Wählen Sie die Konfiguration "Web API" aus dem Dropdown-Menü.
  3. Starten Sie das Debugging.
  4. Wenn Sie Anfragen an das Backend senden (entweder manuell oder über die Gramps Web GUI), wird die Ausführung an allen Breakpoints, die Sie im Code gesetzt haben, angehalten.
    Dies ermöglicht es Ihnen, Variablen, den Kontrollfluss und andere Laufzeitdetails zu inspizieren.

Debugging von Testfällen

Um einen bestimmten Testfall zu debuggen:

  1. Öffnen Sie die Testdatei, die Sie debuggen möchten (zum Beispiel test_people.py).
  2. Öffnen Sie in Visual Studio Code die Ansicht Run and Debug.
  3. Wählen Sie die Konfiguration "Current Test File".
  4. Starten Sie das Debugging - die Ausführung wird an allen Breakpoints, die innerhalb dieser Testdatei gesetzt sind, gestoppt.

Dieses Setup ermöglicht es Ihnen, durch die Testlogik zu schrittweise zu gehen, Variablenwerte zu überprüfen und Testfehler oder unerwartete Ergebnisse besser zu verstehen.