Zum Dokumentationsinhalt springen
Öffentlich

Öffentliche API

OpenAPI-Dokumentation und öffentliche Lese-Endpunkte für Gebiete und Stadtplanner-Flächen.

Interaktive API-Dokumentation #

Das FastAPI-Backend veröffentlicht sein OpenAPI-Schema sowie interaktive Dokumentationen unter /docs und /redoc relativ zur API-Origin. Öffentliche Lese-Endpunkte benötigen keine Anmeldung; schreibende und interne Endpunkte sind separat geschützt.

HTTP
GET /api/v1/analysis-areas
GET /api/v1/analysis-areas/by-slug/{slug}
GET /api/v1/analysis-areas/by-slug/{slug}/analytics
GET /api/v1/analysis-areas/by-slug/{slug}/comparison
GET /api/v1/analysis-areas/by-slug/{slug}/polygons
GET /api/v1/analysis-areas/by-slug/{slug}/statistics
GET /api/v1/analysis-areas/by-slug/{slug}/statistics/{metric_key}
GET /api/v1/data-sources/status

Antworten und Fehler #

Antworten werden als JSON ausgeliefert. Unbekannte Slugs liefern HTTP 404. Das OpenAPI-Schema ist die maßgebliche Referenz für Felder, Typen, Parameter und mögliche geschützte Operationen.

API-Quellcode und lokale Entwicklung #

Implementierung, Datenmodelle, Migrationen und lokale Einrichtungsanleitungen liegen im offiziellen Projekt-Repository. Das veröffentlichte OpenAPI-Schema bleibt die maßgebliche Referenz für die jeweils laufende Instanz.