Compare commits

...
Author SHA1 Message Date
Rudi d7ade96371 Update dockerfile build 2026-10-13 19:42:07 +02:00
Rudi 5a56245218 Update API Doc 2026-10-13 19:26:56 +02:00
Rudi 5d6d8f15f3 delete old files 2026-10-13 19:05:05 +02:00
Rudi 1d1976ed07 delete old files 2026-10-13 19:03:28 +02:00
Rudi 14b8a0c65f API route and script 2026-10-13 19:01:57 +02:00
Rudi df9143e95c added api route 2026-10-13 19:01:31 +02:00
Rudi c234c28d15 openapi.json generate script added 2026-10-13 19:01:22 +02:00
Rudi 87801c5b9b Added a script, to generate openapi.json 2026-10-13 18:59:05 +02:00
Rudi bdc864cf94 Working on Standartisation.... #TODO 2026-08-27 18:07:42 +02:00
Rudi da4d67ea47 Added stream API 2026-08-27 17:00:38 +02:00
20 changed files with 10719 additions and 1923 deletions

No files matched your search

+2 -2
View File
@@ -11,13 +11,13 @@ COPY package.json pnpm-lock.yaml* pnpm-workspace.yaml* ./
RUN apk add --no-cache python3 make g++
# Installation mit deiner funktionierenden Workspace-Konfiguration
RUN pnpm i --frozen-lockfile
RUN npm i --frozen-lockfile
FROM base AS builder
WORKDIR /app
COPY --from=deps /app/node_modules ./node_modules
COPY . .
RUN pnpm run build
RUN npm run openapi:generate; npm run build
FROM base AS runner
WORKDIR /app
+25
View File
@@ -0,0 +1,25 @@
// @/app/api/docs/api/routes.ts
/**
* @openapi
* /api/docs/api:
* get:
* summary: OpenAPI-Spezifikation abrufen
* tags:
* - Docs
* description: Gibt die vollständige OpenAPI-JSON-Spezifikation der API zurück.
* responses:
* 200:
* description: Erfolgreich generierte OpenAPI-Spezifikation.
* content:
* application/json:
* schema:
* type: object
*/
import { NextResponse } from 'next/server';
import spec from '@/src/generated/openapi.json';
export function GET() {
return NextResponse.json(spec);
}
+82 -21
View File
@@ -1,40 +1,60 @@
// @/app/api/songbooks/[songBookId]/route.ts
import { NextResponse } from "next/server";
import { getSongBookById, updateSongBook, deleteSongBook } from "@/lib/db/songbook";
// import { parseInt } from "@/lib/helper/checkvar";
interface RouteParams {
params: Promise<{
songBookId: string;
}>;
};
/**
* @openapi
* /api/songbooks/{id}:
* /api/songbooks/{songBookId}:
* get:
* summary: Einzelnen Songbook abrufen
* summary: Einzelnes Songbook abrufen
* tags:
* - Songbooks
* parameters:
* - in: path
* name: id
* name: songBookId
* required: true
* schema:
* type: integer
* description: Die ID des Songbooks
* example: 1
* responses:
* 200:
* description: Songbook erfolgreich gefunden
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/SongBook'
* 400:
* description: Ungültige Songbook-ID
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
* 404:
* description: Songbook nicht gefunden
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
* 500:
* description: Serverfehler
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
*/
export async function GET(request: Request, { params }) {
export async function GET(_request: Request, { params }: RouteParams) {
try {
const { songBookId } = await params;
const res = await getSongBookById(songBookId);
const res = await getSongBookById(parseInt(songBookId));
if (!res.success) {
return NextResponse.json({ message: res.error }, { status: res.status });
@@ -53,39 +73,63 @@ export async function GET(request: Request, { params }) {
/**
* @openapi
* /api/songbooks/{id}:
* /api/songbooks/{songBookId}:
* patch:
* summary: Songbook aktualisieren
* tags:
* - Songbooks
* parameters:
* - in: path
* name: id
* name: songBookId
* required: true
* schema:
* type: integer
* description: Die ID des Songbooks
* example: 1
* requestBody:
* required: true
* content:
* application/json:
* schema:
* type: object
* properties:
* title:
* type: string
* example: "Feiert Jesus 1"
* language:
* type: string
* example: "DE"
* responses:
* 200:
* description: Songbook erfolgreich aktualisiert
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/SongBook'
* 400:
* description: Ungültige Parameter oder Daten
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
* 404:
* description: Songbook nicht gefunden
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
* 500:
* description: Serverfehler
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
*/
export async function PATCH(request: Request, { params }) {
export async function PATCH(request: Request, { params }: RouteParams) {
try {
const { songBookId } = await params;
const data = await request.json();
const res = await updateSongBook(songBookId, data);
const res = await updateSongBook(parseInt(songBookId), data);
if (!res.success) {
return NextResponse.json({ message: res.error }, { status: res.status });
@@ -95,7 +139,7 @@ export async function PATCH(request: Request, { params }) {
} catch (error) {
console.error("API Error:", error);
return NextResponse.json(
{ error: "Fehler beim Laden der Songbookinfos" },
{ error: "Fehler beim Aktualisieren des Songbooks" },
{ status: 500 }
);
}
@@ -104,32 +148,49 @@ export async function PATCH(request: Request, { params }) {
/**
* @openapi
* /api/songbooks/{id}:
* /api/songbooks/{songBookId}:
* delete:
* summary: Songbook löschen
* tags:
* - Songbooks
* parameters:
* - in: path
* name: id
* name: songBookId
* required: true
* schema:
* type: integer
* description: Die ID des Songbooks
* example: 1
* responses:
* 200:
* description: Songbook erfolgreich gelöscht
* description: Songbook erfolgreich gelöscht (gibt das gelöschte Songbook zurück)
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/SongBook'
* 400:
* description: Ungültige Songbook-ID
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
* 404:
* description: Songbook nicht gefunden
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
* 500:
* description: Serverfehler
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
*/
export async function DELETE(request: Request, { params }) {
export async function DELETE(_request: Request, { params }: RouteParams) {
try {
const { songBookId } = await params;
const res = await deleteSongBook(songBookId);
const res = await deleteSongBook(parseInt(songBookId));
if (!res.success) {
return NextResponse.json({ message: res.error }, { status: res.status });
@@ -139,7 +200,7 @@ export async function DELETE(request: Request, { params }) {
} catch (error) {
console.error("API Error:", error);
return NextResponse.json(
{ error: "Fehler beim Laden der Songbookinfos" },
{ error: "Fehler beim Löschen des Songbooks" },
{ status: 500 }
);
}
@@ -1,6 +1,14 @@
// @/app/api/songbooks/[songBookId]/songs/[songId]/route.ts
import { NextResponse } from "next/server";
import { addSongToBook, updateSongInBook, removeSongFromBook } from "@/lib/db/songbooksongs";
// import { parseInt } from "@/lib/helper/checkvar";
interface RouteParams {
params: Promise<{
songBookId: string;
songId: string;
}>;
};
/**
* @openapi
@@ -8,7 +16,7 @@ import { addSongToBook, updateSongInBook, removeSongFromBook } from "@/lib/db/so
* post:
* summary: Song zu Liederbuch hinzufügen
* tags:
* - Songbook
* - Songbooks
* parameters:
* - in: path
* name: songBookId
@@ -16,12 +24,14 @@ import { addSongToBook, updateSongInBook, removeSongFromBook } from "@/lib/db/so
* schema:
* type: integer
* description: Die ID des Liederbuchs
* example: 1
* - in: path
* name: songId
* required: true
* schema:
* type: integer
* description: Die ID des Songs
* example: 1
* requestBody:
* required: true
* content:
@@ -38,20 +48,36 @@ import { addSongToBook, updateSongInBook, removeSongFromBook } from "@/lib/db/so
* responses:
* 200:
* description: Song erfolgreich zugewiesen
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/SongBookEntry'
* 400:
* description: Ungültige Parameter oder fehlende Songnummer
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
* 409:
* description: Songnummer bereits vergeben oder Song existiert bereits im Buch
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
* 500:
* description: Serverfehler
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
*/
export async function POST(request: Request, { params }) {
export async function POST(request: Request, { params }: RouteParams) {
try {
const { songBookId, songId } = await params;
const data = await request.json();
const res = await addSongToBook(songId, songBookId, data.number);
const res = await addSongToBook(parseInt(songId), parseInt(songBookId), String(data.number));
if (!res.success) {
@@ -62,7 +88,7 @@ export async function POST(request: Request, { params }) {
} catch (error) {
console.error("API Error:", error);
return NextResponse.json(
{ error: "Fehler beim Laden der Songbookinfos" },
{ error: "Fehler beim Zuweisen des Songs" },
{ status: 500 }
);
}
@@ -75,7 +101,7 @@ export async function POST(request: Request, { params }) {
* patch:
* summary: Songnummer eines Songs im Liederbuch aktualisieren
* tags:
* - Songbook
* - Songbooks
* parameters:
* - in: path
* name: songBookId
@@ -83,12 +109,14 @@ export async function POST(request: Request, { params }) {
* schema:
* type: integer
* description: Die ID des Liederbuchs
* example: 1
* - in: path
* name: songId
* required: true
* schema:
* type: integer
* description: Die ID des Songs
* example: 1
* requestBody:
* required: true
* content:
@@ -105,20 +133,40 @@ export async function POST(request: Request, { params }) {
* responses:
* 200:
* description: Songnummer erfolgreich aktualisiert
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/SongBookEntry'
* 400:
* description: Ungültige Parameter oder fehlende Daten
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
* 404:
* description: Zuweisung nicht gefunden
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
* 409:
* description: Neue Songnummer bereits vergeben
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
* 500:
* description: Serverfehler
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
*/
export async function PATCH(request: Request, { params }) {
export async function PATCH(request: Request, { params }: RouteParams) {
try {
const { songBookId, songId } = await params;
const data = await request.json();
const res = await updateSongInBook(songId, songBookId, data);
const res = await updateSongInBook(parseInt(songId), parseInt(songBookId), data);
if (!res.success) {
return NextResponse.json({ message: res.error }, { status: res.status });
@@ -128,7 +176,7 @@ export async function PATCH(request: Request, { params }) {
} catch (error) {
console.error("API Error:", error);
return NextResponse.json(
{ error: "Fehler beim Laden der Songbookinfos" },
{ error: "Fehler beim Aktualisieren der Songnummer" },
{ status: 500 }
);
}
@@ -141,7 +189,7 @@ export async function PATCH(request: Request, { params }) {
* delete:
* summary: Song aus Liederbuch entfernen
* tags:
* - Songbook
* - Songbooks
* parameters:
* - in: path
* name: songBookId
@@ -149,27 +197,45 @@ export async function PATCH(request: Request, { params }) {
* schema:
* type: integer
* description: Die ID des Liederbuchs
* example: 1
* - in: path
* name: songId
* required: true
* schema:
* type: integer
* description: Die ID des Songs
* example: 1
* responses:
* 200:
* description: Song erfolgreich aus dem Liederbuch entfernt
* description: Song erfolgreich aus dem Liederbuch entfernt (gibt die entfernte Zuweisung zurück)
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/SongBookEntry'
* 400:
* description: Ungültige Parameter
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
* 404:
* description: Zuweisung nicht gefunden
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
* 500:
* description: Serverfehler
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
*/
export async function DELETE(request: Request, { params }) {
export async function DELETE(_request: Request, { params }: RouteParams) {
try {
const { songBookId, songId } = await params;
const res = await removeSongFromBook(songId, songBookId);
const res = await removeSongFromBook(parseInt(songId), parseInt(songBookId));
if (!res.success) {
return NextResponse.json({ message: res.error }, { status: res.status });
@@ -179,7 +245,7 @@ export async function DELETE(request: Request, { params }) {
} catch (error) {
console.error("API Error:", error);
return NextResponse.json(
{ error: "Fehler beim Laden der Songbookinfos" },
{ error: "Fehler beim Entfernen des Songs" },
{ status: 500 }
);
}
+46 -8
View File
@@ -1,39 +1,77 @@
// @/app/api/songbooks/[songBookId]/songs/route.ts
import { NextResponse } from "next/server";
import { getSongByNumber } from "@/lib/db/songbooksongs";
interface RouteParams {
params: Promise<{
songBookId: string;
}>;
};
/**
* @openapi
* /api/songbooks/{id}/songs:
* /api/songbooks/{songBookId}/songs:
* get:
* summary: Einen Song nach Nummer in einem Songbook suchen
* tags:
* - Songbook
* - Songbooks
* parameters:
* - in: path
* name: id
* name: songBookId
* required: true
* schema:
* type: integer
* description: Die ID des Songbooks
* example: 1
* - in: query
* name: number
* required: true
* schema:
* type: string
* description: Die Nummer des Songs im Songbook
* example: "123"
* - in: query
* name: n
* required: false
* schema:
* type: string
* description: Alias für `number`
* example: "123"
* responses:
* 200:
* description: Songbook erfolgreich gefunden
* description: Song im Songbook erfolgreich gefunden
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/SongBookEntry'
* 400:
* description: Ungültige Songbook-ID
* description: Ungültige Songbook-ID oder fehlender number-Parameter
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
* 404:
* description: Songbook nicht gefunden
* description: Songbook oder Song nicht gefunden
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
* 500:
* description: Serverfehler
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
*/
export async function GET(request: Request, { params }) {
export async function GET(request: Request, { params }: RouteParams) {
try {
const { songBookId } = await params;
const { searchParams } = new URL(request.url);
const number = searchParams.get("number") || searchParams.get("n");
if(number){
const res = await getSongByNumber(songBookId, number);
const res = await getSongByNumber(parseInt(songBookId), number);
if (!res.success) {
return NextResponse.json({ message: res.error }, { status: res.status });
+47 -21
View File
@@ -1,22 +1,45 @@
// @wikiCategory: Liederbücher
// @/app/api/songbooks/route.ts
import { NextResponse } from "next/server";
import { getSongBooks, searchSongBooksByTitle, createSongBook } from "@/lib/db/songbook";
/**
* @openapi
* /api/songbooks:
* get:
* summary: Get all songbooks
* summary: Get all songbooks or search songbooks by title
* tags:
* - Songbooks
* parameters:
* - in: query
* name: query
* required: false
* schema:
* type: string
* description: Search term for the songbook title
* example: "Feiert Jesus"
* - in: query
* name: q
* required: false
* schema:
* type: string
* description: Alias for `query`
* example: "Feiert Jesus"
* responses:
* 200:
* description: List of songbooks
* description: List of songbooks (filtered by title if a query is given)
* content:
* application/json:
* schema:
* type: array
* items:
* $ref: '#/components/schemas/SongBook'
* 500:
* description: Internal Server Error
*
* @wikiDescription: Liste aller Liederbücher abrufen
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
*/
export async function GET(request: Request) {
try {
@@ -60,6 +83,8 @@ export async function GET(request: Request) {
* /api/songbooks:
* post:
* summary: Creates a new songbook
* tags:
* - Songbooks
* requestBody:
* required: true
* content:
@@ -68,6 +93,7 @@ export async function GET(request: Request) {
* type: object
* required:
* - title
* - language
* properties:
* title:
* type: string
@@ -87,25 +113,25 @@ export async function GET(request: Request) {
* type: boolean
* example: true
* songBook:
* type: object
* properties:
* id:
* type: integer
* example: 1
* title:
* type: string
* example: "Feiert Jesus 1"
* language:
* type: string
* example: "DE"
* $ref: '#/components/schemas/SongBook'
* 400:
* description: Bad Request (missing title)
* description: Bad Request (missing title or language)
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
* 409:
* description: Conflict (title already exists)
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
* 500:
* description: Internal Server Error
*
* @wikiDescription: Neues Liederbuch erstellen
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
*/
export async function POST(request: Request) {
try {
+77 -16
View File
@@ -1,36 +1,59 @@
// @/app/api/songs/[songId]/route.ts
import { NextResponse } from "next/server";
import { getSongById, updateSong, deleteSong } from "@/lib/db/song";
// import { parseInt } from "@/lib/helper/checkvar";
interface RouteParams {
params: Promise<{
songId: string;
}>;
};
/**
* @openapi
* /api/songs/{id}:
* /api/songs/{songId}:
* get:
* summary: Einzelnen Song abrufen
* tags:
* - Songs
* parameters:
* - in: path
* name: id
* name: songId
* required: true
* schema:
* type: integer
* description: Die ID des Songs
* example: 1
* responses:
* 200:
* description: Song erfolgreich gefunden
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Song'
* 400:
* description: Ungültige Song-ID
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
* 404:
* description: Song nicht gefunden
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
* 500:
* description: Serverfehler
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
*/
export async function GET(request: Request, { params }) {
export async function GET(_request: Request, { params }: RouteParams) {
try {
const { songId } = await params;
const res = await getSongById(songId);
const res = await getSongById(parseInt(songId));
if (!res.success) {
return NextResponse.json({ message: res.error }, { status: res.status });
@@ -49,39 +72,60 @@ export async function GET(request: Request, { params }) {
/**
* @openapi
* /api/songs/{id}:
* /api/songs/{songId}:
* patch:
* summary: Song aktualisieren
* tags:
* - Songs
* parameters:
* - in: path
* name: id
* name: songId
* required: true
* schema:
* type: integer
* description: Die ID des Songs
* example: 1
* requestBody:
* required: true
* content:
* application/json:
* schema:
* type: object
* properties:
* title:
* type: string
* example: "Großer Gott"
* responses:
* 200:
* description: Song erfolgreich aktualisiert
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Song'
* 400:
* description: Ungültige Parameter oder Daten
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
* 404:
* description: Song nicht gefunden
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
* 500:
* description: Serverfehler
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
*/
export async function PATCH(request: Request, { params }) {
export async function PATCH(request: Request, { params }: RouteParams) {
try {
const { songId } = await params;
const data = await request.json();
const res = await updateSong(songId, data);
const res = await updateSong(parseInt(songId), data);
if (!res.success) {
return NextResponse.json({ message: res.error }, { status: res.status });
@@ -91,7 +135,7 @@ export async function PATCH(request: Request, { params }) {
} catch (error) {
console.error("API Error:", error);
return NextResponse.json(
{ error: "Fehler beim Laden der Songinfos" },
{ error: "Fehler beim Aktualisieren des Songs" },
{ status: 500 }
);
}
@@ -100,32 +144,49 @@ export async function PATCH(request: Request, { params }) {
/**
* @openapi
* /api/songs/{id}:
* /api/songs/{songId}:
* delete:
* summary: Song löschen
* tags:
* - Songs
* parameters:
* - in: path
* name: id
* name: songId
* required: true
* schema:
* type: integer
* description: Die ID des Songs
* example: 1
* responses:
* 200:
* description: Song erfolgreich gelöscht
* description: Song erfolgreich gelöscht (gibt den gelöschten Song zurück)
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Song'
* 400:
* description: Ungültige Song-ID
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
* 404:
* description: Song nicht gefunden
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
* 500:
* description: Serverfehler
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
*/
export async function DELETE(request: Request, { params }) {
export async function DELETE(_request: Request, { params }: RouteParams) {
try {
const { songId } = await params;
const res = await deleteSong(songId);
const res = await deleteSong(parseInt(songId));
if (!res.success) {
return NextResponse.json({ message: res.error }, { status: res.status });
@@ -135,7 +196,7 @@ export async function DELETE(request: Request, { params }) {
} catch (error) {
console.error("API Error:", error);
return NextResponse.json(
{ error: "Fehler beim Laden der Songinfos" },
{ error: "Fehler beim Löschen des Songs" },
{ status: 500 }
);
}
+53 -23
View File
@@ -1,27 +1,51 @@
// @wikiCategory: Lieder
// @/app/api/songs/route.ts
import { NextResponse } from "next/server";
import { getSongs, searchSongsByTitle, createSong, } from "@/lib/db/song";
import { getSongs, searchSongsByTitle, createSong } from "@/lib/db/song";
/**
* @openapi
* /api/songs:
* get:
* summary: Get all songs
* summary: Get all songs or search songs by title
* tags:
* - Songs
* parameters:
* - in: query
* name: query
* required: false
* schema:
* type: string
* description: Search term for the song title
* example: "Großer Gott"
* - in: query
* name: q
* required: false
* schema:
* type: string
* description: Alias for `query`
* example: "Großer Gott"
* responses:
* 200:
* description: List of songs
* description: List of songs (filtered by title if a query is given)
* content:
* application/json:
* schema:
* type: array
* items:
* $ref: '#/components/schemas/Song'
* 500:
* description: Internal Server Error
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
*/
export async function GET(request: Request) {
try {
const { searchParams } = new URL(request.url);
const query = searchParams.get("query") || searchParams.get("q");
if (query) {
const res = await searchSongsByTitle(query/*, 20*/); // You can enter a limit (default: 20)
@@ -42,7 +66,7 @@ export async function GET(request: Request) {
return NextResponse.json(res.songs, { status: res.status });
} catch (error) {
console.error("POST /api/songs error:", error);
console.error("GET /api/songs error:", error);
return NextResponse.json(
{ message: "Internal Server Error" },
{ status: 500 }
@@ -50,12 +74,13 @@ export async function GET(request: Request) {
}
}
/**
* @openapi
* /api/songs:
* post:
* summary: Creates a new song
* tags:
* - Songs
* requestBody:
* required: true
* content:
@@ -63,14 +88,14 @@ export async function GET(request: Request) {
* schema:
* type: object
* required:
* - name
* - title
* properties:
* name:
* title:
* type: string
* example: "Großer Gott"
* responses:
* 201:
* description: Songbook successfully created
* description: Song successfully created
* content:
* application/json:
* schema:
@@ -79,21 +104,26 @@ export async function GET(request: Request) {
* success:
* type: boolean
* example: true
* songBook:
* type: object
* properties:
* id:
* type: integer
* example: 1
* title:
* type: string
* example: "Großer Gott"
* song:
* $ref: '#/components/schemas/Song'
* 400:
* description: Bad Request (missing name)
* description: Bad Request (missing title)
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
* 409:
* description: Conflict (title already exists)
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
* 500:
* description: Internal Server Error
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
*/
export async function POST(request: Request) {
try {
@@ -101,7 +131,7 @@ export async function POST(request: Request) {
if (!data.title) {
return NextResponse.json(
{ message: "Field 'title' is required"},
{ message: "Field 'title' is required" },
{ status: 400 }
);
}
-52
View File
@@ -1,52 +0,0 @@
// @wikiCategory: Stream
import { NextResponse } from "next/server";
import { getSong } from "@/lib/db/managing";
let currentSong = {
songID: "",
songbook: "",
number: "",
title: ""
};
// @wikiDescription: Akutell gestreamtes Lied abrufen
export async function GET() {
return NextResponse.json(currentSong)
}
// @wikiDescription: Lied zum Streamen festlegen
export async function POST(request: Request) {
try {
const data = await request.json();
const songID = data.songID;
const songbookID = data.songbookID;
if (!songID || !songbookID) {
return NextResponse.json({ success: false, error: "Fields incomplete!" }, { status: 400 });
}
const song = await getSong(Number(songbookID), String(songID));
if (song) {
currentSong = {
songID: String(songID),
songbook: song.songbook_name,
number: song.number,
title: song.song_title,
};
} else {
currentSong = {
songID: "",
songbook: "",
number: "",
title: "",
};
}
console.log(currentSong);
return NextResponse.json({ success: true });
} catch (error) {
return NextResponse.json({ success: false, error: "Server-Fehler" }, { status: 500 });
}
}
+161
View File
@@ -0,0 +1,161 @@
// @/app/api/stream/route.ts
import { NextResponse } from "next/server";
/**
* @openapi
* components:
* schemas:
* StreamError:
* type: object
* properties:
* success:
* type: boolean
* example: false
* error:
* type: string
* example: "Fields incomplete!"
*/
let currentSong = {
number: "",
song: "",
songbook: "",
};
const clients = new Set<ReadableStreamDefaultController>();
/**
* @openapi
* /api/stream:
* get:
* summary: Aktuell gestreamtes Lied abrufen (Server-Sent Events)
* description: Öffnet einen SSE-Stream. Beim Verbinden wird das aktuelle Lied gesendet (falls gesetzt), danach bei jeder Änderung ein neues Event.
* tags:
* - Stream
* responses:
* 200:
* description: Event-Stream mit dem aktuellen Lied
* content:
* text/event-stream:
* schema:
* type: string
* example: 'data: {"number":"104a","song":"Großer Gott","songbook":"Feiert Jesus 1"}'
*/
export async function GET() {
let controllerRef: ReadableStreamDefaultController;
const stream = new ReadableStream({
start(controller) {
controllerRef = controller;
clients.add(controller);
if (currentSong.song) {
controller.enqueue(`data: ${JSON.stringify(currentSong)}\n\n`);
}
},
cancel() {
clients.delete(controllerRef);
},
});
return new NextResponse(stream, {
headers: {
'Content-Type': 'text/event-stream',
'Cache-Control': 'no-cache',
'Connection': 'keep-alive',
},
});
}
/**
* @openapi
* /api/stream:
* post:
* summary: Lied zum Streamen festlegen
* description: Setzt das aktuelle Lied und sendet es an alle verbundenen Stream-Clients.
* tags:
* - Stream
* requestBody:
* required: true
* content:
* application/json:
* schema:
* type: object
* required:
* - song
* - songBook
* - number
* properties:
* song:
* type: string
* example: "Großer Gott"
* songBook:
* type: string
* example: "Feiert Jesus 1"
* number:
* type: string
* example: "104a"
* responses:
* 200:
* description: Lied gesetzt und an alle Clients gesendet
* content:
* application/json:
* schema:
* type: object
* properties:
* success:
* type: boolean
* example: true
* currentSong:
* type: object
* properties:
* number:
* type: string
* example: "104a"
* song:
* type: string
* example: "Großer Gott"
* songbook:
* type: string
* example: "Feiert Jesus 1"
* 400:
* description: Felder unvollständig
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/StreamError'
* 500:
* description: Serverfehler
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/StreamError'
*/
export async function POST(request: Request) {
try {
const data = await request.json();
const song = data.song?.trim() ?? null;
const songbook = data.songBook?.trim() ?? null;
const number = data.number?.trim() ?? null;
if (song == null || songbook == null || number == null) {
return NextResponse.json({ success: false, error: "Fields incomplete!" }, { status: 400 });
}
currentSong = {
song,
songbook,
number
};
clients.forEach((controller) => {
controller.enqueue(`data: ${JSON.stringify(currentSong)}\n\n`);
});
return NextResponse.json({ success: true , currentSong }, { status: 200 });
} catch (error) {
return NextResponse.json({ success: false, error: "Server-Fehler" }, { status: 500 });
}
}
+8
View File
@@ -0,0 +1,8 @@
'use client';
import SwaggerUI from 'swagger-ui-react';
import 'swagger-ui-react/swagger-ui.css';
export default function DocsPage() {
return <SwaggerUI url="/api/docs/api" />;
}
-34
View File
@@ -1,34 +0,0 @@
import { getAllApis } from "@/lib/wiki";
import Article from '@/components/wiki/Article';
import { API } from '@/components/mdx-components';
export default async function Page() {
const allApis = await getAllApis();
// Gruppiert die APIs nach ihrer Kategorie
const groupedApis = Object.groupBy(allApis, (api) => api.category);
return (
<Article title="API-Endpunkte">
{Object.entries(groupedApis).map(([category, apis]) => (
<div key={category} className="mb-10">
{/* Kategorie-Überschrift wird nur EINMAL pro Kategorie gerendert */}
<h2 className="text-2xl font-bold text-white mt-10 mb-4 border-b border-zinc-800 pb-2">
{category}
</h2>
{/* Routen innerhalb dieser Kategorie durchgehen */}
{apis?.map((api, index) => (
<div key={index} className="my-4">
{api.methods.map((method, mIndex) => (
<API route={api.route} method={method.method} key={mIndex}>
{method.description}
</API>
))}
</div>
))}
</div>
))}
</Article>
);
}
+42
View File
@@ -0,0 +1,42 @@
export interface Song {
id: number;
title: string;
}
export interface SongBook {
id: number;
title: string;
language?: string;
}
export interface SongDetailed {
song: {
id: number;
title: string;
songBooks?:{songNumber: number; book:SongBook}[]
};
}
export type APIResponse<T> =
| { success: true; status: number; data: T }
| { success: false; status: number; error: string };
export type GetSongsResponse = APIResponse<Song[]>;
export type GetSongDetailedResponse =
| {
success: true;
status: number;
song: SongDetailed
}
| { success: false; status: number; error: string };
export type GetSongsDelailedResponse =
| {
success: true;
status: number;
songs: SongDetailed[]
}
| { success: false; status: number; error: string };
export type CreateSongsResponse = APIResponse<Song>;
+15 -8
View File
@@ -1,7 +1,14 @@
import { prisma } from "@/lib/db/prisma";
import { parseInt } from "@/lib/helper/checkvar";
import type * as API from "./response";
// For Error checking use this import: import { Prisma } from "@prisma/client";
interface Response {
success: boolean;
status: number;
songs?: [];
error?: string;
}
/**
* GetSongs
@@ -9,7 +16,7 @@ import { parseInt } from "@/lib/helper/checkvar";
*
* @returns {"success": boolean, "status": number, "songs": [{"id":number, "title": string},...]}
*/
export async function getSongs() {
export async function getSongs(): Promise<API.GetSongsResponse> {
try{
const songs = await prisma.song.findMany({
select: {
@@ -35,7 +42,7 @@ export async function getSongs() {
* @param id - ID indicatin the song
* @returns {"success": boolean, "status": number, "song": {"id":number, "title": string, "songBooks": [{"songNumber": number, "book": {"title": string, "language": string}},...]}}
*/
export async function getSongById(rawId: number) {
export async function getSongById(rawId: number): Promise<API.GetSongDetailedResponse> {
try{
const id = parseInt(rawId);
if (!id) {
@@ -78,13 +85,13 @@ export async function getSongById(rawId: number) {
*
* @param query - The search term for the song title.
* @param limit - Max number of songs returned for performance (default: 20).
* @returns @returns {"success": boolean, "status": number, "song": {"id":number, "title": string, "songBooks": [{"songNumber": number, "book": {"title": string, "language": string}},...]}}
* @returns {"success": boolean, "status": number, "song": {"id":number, "title": string, "songBooks": [{"songNumber": number, "book": {"title": string, "language": string}},...]}}
*/
export async function searchSongsByTitle(query: string, limit: number = 20) {
export async function searchSongsByTitle(query: string, limit: number = 20): Promise<API.GetSongsDelailedResponse> {
try {
const cleanQuery = query.trim();
if (!cleanQuery) {
return { success: true, songBooks: [] };
return { success: true, status: 200, songs: [] };
}
const songs = await prisma.song.findMany({
@@ -124,7 +131,7 @@ export async function searchSongsByTitle(query: string, limit: number = 20) {
* @param data - object with title
* @returns {"success": boolean, "status": number, "song": {"id":number, "title": string}}
*/
export async function createSong(data: { title: string }) {
export async function createSong(data: { title: string }): Promise<API.CreateSongsResponse> {
try{
if(!data.title){
return { success: false, status: 400, error: "Field 'title' is required" };
@@ -164,7 +171,7 @@ export async function createSong(data: { title: string }) {
export async function updateSong(
rawId: number,
data: { title?: string }
) {
): Promise<API.CreateSongsResponse> {
try {
const id = parseInt(rawId);
if (!id) {
@@ -213,7 +220,7 @@ export async function updateSong(
* @param id - ID indicatin the song
* @returns {"success": boolean, "status": number, "song": {"id": number, "title": string}}
*/
export async function deleteSong(rawId: number) {
export async function deleteSong(rawId: number): Promise<API.CreateSongsResponse> {
try {
const id = parseInt(rawId);
if (!id) {
+1 -1
View File
@@ -1,6 +1,6 @@
export function parseInt(rawInteger){
export function parseInt(rawInteger: number){
const integer = Number.parseInt(rawInteger);
if (Number.isNaN(integer) || !Number.isInteger(integer)) {
-228
View File
@@ -1,228 +0,0 @@
import fs from 'fs';
import path from 'path';
import matter from 'gray-matter';
import ts from 'typescript';
import { ApiRoute, ApiMethod } from '@/types/api';
export type WikiArticle = {
slug: string;
title: string;
rawContent: string;
updatedAt?: string;
};
export type WikiPage = {
title: string;
path: string;
}
const wikiDirectory = path.join(process.cwd(), "data/wiki/pages");
export async function getWikiPageBySlug(slug: string): Promise<WikiArticle | null> {
try {
const fullPath = path.join(wikiDirectory, `${slug}.mdx`);
const fileContents = fs.readFileSync(fullPath, "utf-8");
const { data, content } = matter(fileContents);
return {
slug,
rawContent: content,
title: data.title || 'Unbenannt',
updatedAt: data.updatedAt || null,
...data,
} as WikiArticle;
} catch (error) {
return null;
}
}
/**
* Liest rekursiv alle Dateien aus einem Verzeichnis aus.
* @param dirPath - Der Startordner
* @param extension - Optionale Dateiendung zur Filterung (z. B. ".ts" oder "ts")
* @returns Array mit den Dateipfaden
*/
export function getAllFiles(dirPath: string, extension?: string): string[] {
if (!fs.existsSync(dirPath)) return [];
let results: string[] = [];
// optionales führendes Dot sicherstellen (z. B. aus "ts" wird ".ts")
const targetExt = extension && !extension.startsWith('.')
? `.${extension}`
: extension;
// withFileTypes: true spart zusätzliche fs.statSync Aufrufe
const entries = fs.readdirSync(dirPath, { withFileTypes: true });
for (const entry of entries) {
const fullPath = path.join(dirPath, entry.name);
if (entry.isDirectory()) {
results = results.concat(getAllFiles(fullPath, targetExt));
} else if (!targetExt || entry.name.endsWith(targetExt)) {
results.push(fullPath);
}
}
return results;
}
/**
* Liest die Kategorie aus der Datei aus (@wikiCategory) oder ermittelt sie aus dem Ordnernamen.
*/
export function filterCategory(
content: string,
filePath: string,
prefix: string = '@wikiCategory'
): string {
// 1. In Kommentaren nach @wikiCategory suchen
const lines = content.split('\n');
for (const line of lines) {
const cleaned = line.replace(/^\/\/\s*/, '').replace(/^\/\*\*?\s*/, '').replace(/\*\/$/, '').trim();
if (cleaned.startsWith(prefix)) {
let category = cleaned.slice(prefix.length).trim().replace(/^:\s*/, '');
if (category) return category;
}
}
// 2. Fallback: Ersten Ordnernamen unter app/api/ als Kategorie nutzen
const normalizedPath = filePath.replace(/\\/g, '/');
const apiMatch = normalizedPath.match(/app\/api\/([^/]+)/);
if (apiMatch && apiMatch[1]) {
const folderName = apiMatch[1];
// Ersten Buchstaben großschreiben (z. B. "stream" -> "Stream")
return folderName.charAt(0).toUpperCase() + folderName.slice(1);
}
return 'Allgemein';
}
/**
* Parst TypeScript-Code via AST und extrahiert HTTP-Methoden sowie deren Kommentare.
*/
export function filterMethods(
content: string,
prefix: string = '@wikiDescription'
): ApiMethod[] {
const sourceFile = ts.createSourceFile(
'temp.ts',
content,
ts.ScriptTarget.Latest,
/* setParentNodes */ true
);
const methods: ApiMethod[] = [];
const validMethods = new Set(['GET', 'POST', 'PUT', 'PATCH', 'DELETE']);
ts.forEachChild(sourceFile, (node) => {
if (ts.isFunctionDeclaration(node) && node.name) {
const functionName = node.name.text;
if (validMethods.has(functionName)) {
let description = '';
const commentRanges = ts.getLeadingCommentRanges(content, node.pos);
if (commentRanges && commentRanges.length > 0) {
const lastCommentRange = commentRanges[commentRanges.length - 1];
const rawComment = content.substring(
lastCommentRange.pos,
lastCommentRange.end
);
const cleanedComment = rawComment
.replace(/^\/\/\s*/, '')
.replace(/^\/\*\*?\s*/, '')
.replace(/\*\/$/, '')
.split('\n')
.map((line) => line.replace(/^\s*\*\s?/, '').trim())
.join(' ')
.trim();
if (cleanedComment.startsWith(prefix)) {
let textAfterPrefix = cleanedComment.slice(prefix.length).trim();
textAfterPrefix = textAfterPrefix.replace(/^:\s*/, '');
description = textAfterPrefix;
}
}
methods.push({
method: functionName,
description: description || 'Keine Beschreibung vorhanden.',
});
}
}
});
return methods;
}
/**
* Liest alle API-Dateien dynamisch aus und wandelt sie in ApiRoute-Objekte um.
*/
export async function getAllApis(): Promise<ApiRoute[]> {
try {
const apiBasePath = path.join(process.cwd(), "app/api");
const allTsFiles = getAllFiles(apiBasePath, ".ts");
const routes: ApiRoute[] = [];
allTsFiles.forEach((filePath) => {
const fileContents = fs.readFileSync(filePath, "utf-8");
// 1. Methoden extrahieren
const methods = filterMethods(fileContents, "@wikiDescription");
// Nur Routen hinzufügen, die auch API-Methoden exportieren
if (methods.length > 0) {
// 2. Kategorie ermitteln
const category = filterCategory(fileContents, filePath, "@wikiCategory");
// 3. Route-Pfad automatisch aus dem Dateipfad generieren (app/api/stream/currentID/route.ts -> stream/currentID)
const relativePath = path.relative(apiBasePath, filePath).replace(/\\/g, '/');
const routePath = relativePath
.replace(/\/route\.ts$/, '')
.replace(/\.ts$/, '');
routes.push({
route: routePath,
category,
methods,
});
}
});
return routes;
} catch (error) {
console.error("Fehler beim Auslesen der API-Dateien:", error);
return [];
}
}
export async function getAllWikiPages(): Promise<WikiPage[]> {
try {
const pagesBasePath = path.join(process.cwd(), "data/wiki/pages");
const allPaths = getAllFiles(pagesBasePath, ".mdx");
const allPages: WikiPage[] = [];
for (const filePath of allPaths) {
// extract filename of the path (e. g. "test" at "data/wiki/pages/test.mdx")
const slug = path.parse(filePath).name;
const wikiPage = await getWikiPageBySlug(slug);
if (wikiPage) {
allPages.push({
path: slug,
title: wikiPage.title,
});
}
}
console.log(allPages);
return allPages;
} catch (error) {
console.error("Fehler beim Auslesen der Wiki-Seiten:", error);
return [];
}
}
+8880 -1490
View File
File diff suppressed because it is too large. Load diff
+10 -5
View File
@@ -6,20 +6,20 @@
"dev": "next dev",
"build": "next build",
"start": "next start",
"lint": "eslint"
"lint": "eslint",
"openapi:generate": "node scripts/generate-openapi.mjs"
},
"dependencies": {
"@prisma/adapter-better-sqlite3": "^7.9.1",
"@prisma/client": "^7.9.1",
"@prisma/client": "^7.10.0",
"@types/papaparse": "^5.5.2",
"argon2": "^0.45.1",
"better-sqlite3": "^13.0.2",
"dotenv": "^17.4.2",
"gray-matter": "^4.0.3",
"next": "16.2.9",
"next": "^16.4.0",
"next-mdx-remote": "^6.0.0",
"papaparse": "^5.5.4",
"prisma": "^7.9.1",
"react": "19.2.4",
"react-dom": "19.2.4",
"rehype-autolink-headings": "^7.1.0",
@@ -31,7 +31,8 @@
"remark-html": "^16.0.1",
"remark-parse": "^11.0.0",
"remark-rehype": "^11.1.2",
"shiki": "^4.4.1"
"shiki": "^4.4.1",
"swagger-ui-react": "^5.33.2"
},
"devDependencies": {
"@tailwindcss/postcss": "^4",
@@ -40,8 +41,12 @@
"@types/node": "^20",
"@types/react": "^19",
"@types/react-dom": "^19",
"@types/swagger-jsdoc": "^6.0.4",
"@types/swagger-ui-react": "^5.18.0",
"eslint": "^9",
"eslint-config-next": "16.2.9",
"prisma": "^8.0.0-rc.22",
"swagger-jsdoc": "^6.3.0",
"tailwindcss": "^4",
"typescript": "^5.9.3"
},
+18
View File
@@ -0,0 +1,18 @@
import swaggerJsdoc from 'swagger-jsdoc';
import { mkdirSync, writeFileSync } from 'node:fs';
import { dirname } from 'node:path';
const spec = swaggerJsdoc({
definition: {
openapi: '3.0.0',
info: { title: 'PsalmTafel API', version: '1.0.0' },
},
apis: ['./app/api/**/*.ts'],
failOnErrors: true,
});
const out = 'src/generated/openapi.json';
mkdirSync(dirname(out), { recursive: true });
writeFileSync(out, JSON.stringify(spec, null, 2));
console.log(`OpenAPI: ${Object.keys(spec.paths ?? {}).length} Pfade -> ${out}`);
File diff suppressed because it is too large. Load diff