Swagger UI ist der Goldstandard für REST-API-Dokumentation. Aber wenn du versucht hast, eine Firestore-Datenbank damit zu dokumentieren, bist du wahrscheinlich an Grenzen gestoßen. Firestore ist keine REST-API — es ist eine Dokumenten-Datenbank mit Sammlungen, Untersammlungen und verschachtelten Daten. Es braucht eine andere Art von Werkzeug.
Was ist Swagger UI?
Swagger UI rendert interaktive Dokumentation aus OpenAPI-Spezifikationen. Es ist für REST-APIs konzipiert: Endpunkte, HTTP-Methoden, Request/Response-Bodies, Statuscodes. Wenn du eine REST-API baust, ist Swagger hervorragend — es zeigt Entwicklern genau, wie sie jeden Endpunkt aufrufen, welche Parameter sie senden und welche Antworten sie erwarten können.
Warum Swagger nicht zu Firestore passt
Firestore unterscheidet sich grundlegend von einer REST-API:
Keine Endpunkte
Firestore verwendet Sammlungsreferenzen, keine URL-Routen. Es gibt kein GET /users oder POST /orders — du interagierst über das Firebase SDK mit Sammlungspfaden wie users/{userId}/orders.
Sammlungen ≠ Routen
Eine Firestore-Sammlung ist eine Gruppe von Dokumenten mit flexiblen Schemas, keine REST-Ressource mit festen Request/Response-Formen. Untersammlungen fügen eine weitere Dimension hinzu, die REST nicht gut abbilden kann.
Schema unterscheidet sich von API-Verträgen
OpenAPI beschreibt HTTP-Schnittstellen. Firestore braucht Schema auf Dokumentenebene: Feldtypen, Validierungsregeln, verschachtelte Objekte und die Beziehungen zwischen Sammlungen und Untersammlungen.
Was ist FireSchema?
FireSchema wurde speziell für Dokumenten-Datenbanken entwickelt. Anstelle von OpenAPI-Spezifikationen verwendet es JSON Schema-Dateien — eine pro Sammlung — organisiert in Ordnern, die deine Firestore-Hierarchie widerspiegeln. Es rendert einen interaktiven Viewer, der deinen Sammlungsbaum, Dokumentfelder, Typen und Beschreibungen anzeigt. JSON Schema.
Funktionsvergleich
| Funktion | Swagger UI | FireSchema |
|---|---|---|
| Entwickelt für | REST APIs | NoSQL-Datenbanken |
| Spezifikationsformat | OpenAPI (YAML/JSON) | JSON Schema |
| Datenmodell | Endpunkte & Methoden | Sammlungen & Dokumente |
| Untersammlungen | Nicht unterstützt | Ordner = Hierarchie |
| Backend erforderlich | Oft ja | Nie |
| Einrichtungszeit | Minuten bis Stunden | Unter 5 Minuten |
| Ausprobieren-Aufrufe | Ja (API-Aufrufe) | Nein (reine Dokumentation) |
Wann welches verwenden
Verwende Swagger UI, wenn:
- -Du eine REST-API mit HTTP-Endpunkten hast
- -Du interaktives API-Testen brauchst (Ausprobieren)
- -Dein Team bereits OpenAPI-Spezifikationen nutzt
Verwende FireSchema, wenn:
- -Du Firestore oder eine andere Dokumenten-Datenbank nutzt
- -Du dein Datenmodell dokumentieren möchtest (nicht API-Endpunkte)
- -Du Backend-freie Doku brauchst die als statische Dateien funktioniert
- -Du in unter 5 Minuten starten möchtest
Verwende beide, wenn:
Dein Projekt eine REST-API mit Firestore-Backend hat. Nutze Swagger für die API-Schicht und FireSchema für die Datenbankschicht.
Jetzt starten
FireSchema gibt deiner Firestore-Datenbank die gleiche Dokumentationsqualität, die Swagger REST-APIs bietet. Richte es in 5 Minuten ein und stelle es als statische Seite bereit. Get started in 5 minutes →