Interaktive Swagger UI & Code-Beispiele
Vollständige OpenAPI 3.1 Dokumentation mit Live-Explorer, cURL-Befehlen, TypeScript- und Python-Beispielen
Interaktive Swagger UI & API Explorer
Auf dieser Seite kannst du alle 22 Endpunkte des LoreKeeper Fastify AI Backend-Dienstes interaktiv im Browser testen, Schemata analysieren und Requests live gegen deine Instanz ausführen.
Lokale Entwicklungs-URL: Standardmäßig ist http://localhost:3005 ausgewählt. Achte darauf, dass der Backend-Dienst (npm run dev) aktiv ist, wenn du das interaktive „Try it out“-Feature nutzt.
💻 Schnellstart: Code- & cURL-Beispiele
Hier findest du praxiserprobte Code-Snippets für die wichtigsten Kernfunktionen in cURL, TypeScript (Fetch) und Python (Requests):
1. Buch-Ingestion starten (POST /api/books/ingest)
curl -X POST http://localhost:3005/api/books/ingest \
-H "Content-Type: application/json" \
-d '{
"bufferBase64": "UEsDBBQAAAAIAKBmV1YAAAAAA...",
"filename": "die-chroniken-von-eldoria.epub",
"options": {
"persistToDirectus": true,
"language": "de",
"targetWordsPerScene": 350,
"filterPromos": true,
"includeImages": true
}
}'2. Visuelle Entitätssegmentierung (POST /api/entities/extract-visual)
curl -X POST http://localhost:3005/api/entities/extract-visual \
-H "Content-Type: application/json" \
-d '{
"imageFileId": "6761713f-29da-4962-8369-bea14af16d7c",
"candidates": [
{ "name": "Mira", "type": "character" },
{ "name": "Jaro", "type": "character" }
],
"options": {
"persistToDirectus": true
}
}'3. Kanontreue Szene generieren (POST /api/scenes/generate)
curl -X POST http://localhost:3005/api/scenes/generate \
-H "Content-Type: application/json" \
-d '{
"bookId": "b1a2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d",
"chapterNumber": 2,
"sceneNumber": 1,
"title": "Das Floß am Klippenstrand",
"prompt": "Mira und Jaro bauen gemeinsam ein Floß aus Treibholz.",
"saveToDirectus": true
}'⚡ Live API Explorer (Interaktive Swagger UI)
Klicke auf einen beliebigen Endpunkt, um Parameter, Schemata und Response-Objekte einzusehen oder klicke auf „Try it out“, um Live-Requests auszuführen:
Lade interaktive API-Spezifikation...
Bereite Endpunkte, Schemen und cURL-Beispiele vor
📥 Direkter Download der Spezifikationen
- JSON Format:
/openapi.json– Ideal für automatische Code-Generatoren (openapi-typescript, Orval). - YAML Format:
/openapi.yaml– Für Postman, Insomnia oder Swagger Editor.