Die REST-API unter http://docs.bbasic.de/api/v1 deckt alles ab, was die Oberfläche kann. Die interaktive Dokumentation steht unter
/api/docs (Swagger UI).

Abb.: Swagger UI: alle Endpunkte zum Ausprobieren
Anmelden
curl -s http://docs.bbasic.de/api/v1/auth/login -H "Content-Type: application/json" \
-d '{"username":"anna","password":"…","persistent":true,"deviceName":"Importskript"}'
# → { "token": "bbh_…", … }
Wichtige Endpunkte
| Methode | Pfad | Zweck |
|---|---|---|
| GET | /projects | lesbare Handbücher |
| GET | /projects/{id}/tree | Inhaltsverzeichnis |
| GET | /search?q=… | Volltextsuche |
| GET | /topics/{id}?includeBody=true | Seite lesen |
| POST | /projects/{id}/topics | Seite anlegen |
| PATCH | /topics/{id} | nur gesetzte Felder ändern |
| POST | /projects/{id}/media | Bild hochladen, optional insertInto |
| GET | /topics/{id}/revisions | Verlauf |
| GET | /projects/{id}/pdf | PDF erzeugen |
Fehler
| HTTP | Bedeutung |
|---|---|
| 401 | nicht angemeldet oder Token ungültig – kein stiller Rückfall auf anonym |
| 403 | angemeldet, aber ohne Recht |
| 404 | nicht gefunden – auch für Leser verborgene Seiten |
| 503 | PDF nicht verfügbar (kein Edge/Chrome auf dem Server) |
{ "error": "forbidden", "detail": "Schreibrecht für dieses Projekt oder Admin erforderlich." }