diff --git a/README.md b/README.md
index effcce9..54c981f 100644
--- a/README.md
+++ b/README.md
@@ -24,7 +24,7 @@ PsalmTafel is a real-time display system designed for choirs. It enables the cho
For detailed installation guides and deployment instructions, please visit our Wiki:
-* [PsalmTafel Wiki – Installation Guide](https://git.schamagusa.de/Schanbro/PsalmTafel/wiki/Installation)
+* [PsalmTafel Wiki – Installation Guide](https://psalmtafel.gem.schamagusa.de/wiki/installation)
---
diff --git a/app/api/songbooks/route.ts b/app/api/songbooks/route.ts
index 124a7b3..3d4d542 100644
--- a/app/api/songbooks/route.ts
+++ b/app/api/songbooks/route.ts
@@ -1,7 +1,9 @@
+// @wikiCategory: Liederbücher
+
import { NextResponse } from "next/server";
import { getSongbooks, addSongbook } from "@/lib/db/managing";
-
+// @wikiDescription: Liste aller Liederbücher abrufen
export async function GET() {
try {
const songbooks = await getSongbooks();
@@ -10,6 +12,8 @@ export async function GET() {
return NextResponse.json({ success: false, message: error}, { status: 500})
}
}
+
+// @wikiDescription: Neues Liederbuch erstellen
export async function POST(request: Request) {
try {
const { name, language } = await request.json();
diff --git a/app/api/songs/[id]/route.ts b/app/api/songs/[id]/route.ts
index 7b43176..459ff28 100644
--- a/app/api/songs/[id]/route.ts
+++ b/app/api/songs/[id]/route.ts
@@ -1,6 +1,9 @@
+// @wikiCategory: Lieder
+
import { NextResponse } from "next/server";
import { getSongInfos } from "@/lib/db/managing";
+// @wikiDescription: Informationen eines Liedes abrufen
export async function GET(
request: Request,
{ params }: { params: Promise<{ id: string }> }
diff --git a/app/api/songs/attach/route.ts b/app/api/songs/attach/route.ts
index cceaddb..e401b64 100644
--- a/app/api/songs/attach/route.ts
+++ b/app/api/songs/attach/route.ts
@@ -1,6 +1,9 @@
+// @wikiCategory: Lieder
+
import { NextResponse } from "next/server";
import { attachSongToSongbook } from "@/lib/db/managing";
+// @wikiDescription: Lied zu einem Liederbuch hinzufügen
export async function POST(request: Request) {
try {
const body = await request.json();
diff --git a/app/api/songs/remove/route.ts b/app/api/songs/remove/route.ts
index 42745b6..e589221 100644
--- a/app/api/songs/remove/route.ts
+++ b/app/api/songs/remove/route.ts
@@ -1,6 +1,9 @@
+// @wikiCategory: Lieder
+
import { NextResponse } from "next/server";
import { removeSongfromSongbook } from "@/lib/db/managing";
+// @wikiDescription: Lied von einem Liederbuch entfernen
export async function POST(request: Request) {
try {
const body = await request.json();
diff --git a/app/api/songs/route.ts b/app/api/songs/route.ts
index 97f3a4c..a48c80b 100644
--- a/app/api/songs/route.ts
+++ b/app/api/songs/route.ts
@@ -1,7 +1,10 @@
+// @wikiCategory: Lieder
+
import { NextResponse } from "next/server";
import { getSongs, addSongToSongbook } from "@/lib/db/managing";
+// @wikiDescription: Liste aller Lieder abrufen
export async function GET() {
const songs = await getSongs();
if (songs) {
@@ -10,6 +13,8 @@ export async function GET() {
return NextResponse.json({ success: false}, { status: 500})
}
}
+
+// @wikiDescription: Lied in einem Liederbuch erstellen
export async function POST(request: Request) {
try {
const { title, songbookId, number } = await request.json();
diff --git a/app/api/stream/currentID/route.ts b/app/api/stream/currentID/route.ts
index fae21b0..31abe54 100644
--- a/app/api/stream/currentID/route.ts
+++ b/app/api/stream/currentID/route.ts
@@ -1,3 +1,5 @@
+// @wikiCategory: Stream
+
import { NextResponse } from "next/server";
import { getSong } from "@/lib/db/managing";
@@ -8,10 +10,12 @@ let currentSong = {
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();
diff --git a/app/wiki/[slug]/page.tsx b/app/wiki/[slug]/page.tsx
index 266e67e..253fb0b 100644
--- a/app/wiki/[slug]/page.tsx
+++ b/app/wiki/[slug]/page.tsx
@@ -4,7 +4,8 @@ import { MDXRemote } from 'next-mdx-remote/rsc';
import rehypePrettyCode from 'rehype-pretty-code';
import rehypeSlug from 'rehype-slug';
import rehypeAutolinkHeadings from 'rehype-autolink-headings';
-import { Callout, Grid, Card, Steps, Step, InlineCode, CodeBlockContainer } from '@/components/mdx-components';
+import { Callout, Grid, Card, Steps, Step, InlineCode, CodeBlockContainer, API } from '@/components/mdx-components';
+import Article from '@/components/wiki/Article';
const mdxOptions = {
mdxOptions: {
@@ -43,6 +44,7 @@ const mdxComponents = {
Card,
Steps,
Step,
+ API,
// Custom Typography Überschreibungen
code: InlineCode,
pre: CodeBlockContainer,
@@ -66,19 +68,26 @@ export default async function Page({ params }: PageProps) {
}
return (
-
-
+ //
+ //
+ //
+ //
+
-
+ source={article.rawContent}
+ components={mdxComponents}
+ options={mdxOptions as any}
+ />
+
);
}
\ No newline at end of file
diff --git a/app/wiki/api/page.tsx b/app/wiki/api/page.tsx
new file mode 100644
index 0000000..84618bf
--- /dev/null
+++ b/app/wiki/api/page.tsx
@@ -0,0 +1,34 @@
+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 (
+
+ {Object.entries(groupedApis).map(([category, apis]) => (
+
+ {/* Kategorie-Überschrift wird nur EINMAL pro Kategorie gerendert */}
+
+ {category}
+
+
+ {/* Routen innerhalb dieser Kategorie durchgehen */}
+ {apis?.map((api, index) => (
+
+ {api.methods.map((method, mIndex) => (
+
+ {method.description}
+
+ ))}
+
+ ))}
+
+ ))}
+
+ );
+}
\ No newline at end of file
diff --git a/components/mdx-components.tsx b/components/mdx-components.tsx
index 654d488..dd680a0 100644
--- a/components/mdx-components.tsx
+++ b/components/mdx-components.tsx
@@ -116,4 +116,46 @@ export function CodeBlockContainer({ children, ...props }: React.HTMLAttributes<
{children}
);
+}
+
+export function API({
+ method = 'GET',
+ route,
+ children
+}: {
+ method?: string;
+ route: string;
+ children?: React.ReactNode;
+}) {
+ const methodUpper = method.toUpperCase();
+
+ // Farben für die verschiedenen HTTP-Methoden
+ const methodStyles: Record = {
+ GET: 'bg-emerald-500/10 text-emerald-400 border-emerald-500/30',
+ POST: 'bg-blue-500/10 text-blue-400 border-blue-500/30',
+ PUT: 'bg-amber-500/10 text-amber-400 border-amber-500/30',
+ PATCH: 'bg-orange-500/10 text-orange-400 border-orange-500/30',
+ DELETE: 'bg-rose-500/10 text-rose-400 border-rose-500/30',
+ };
+
+ const badgeStyle = methodStyles[methodUpper] || 'bg-zinc-800 text-zinc-300 border-zinc-700';
+
+ return (
+
+ {/* Route & Methoden-Header */}
+
+
+ {methodUpper}
+
+ /api/{route}
+
+
+ {/* Beschreibung / Inhalt */}
+ {children && (
+
+ {children}
+
+ )}
+
+ );
}
\ No newline at end of file
diff --git a/components/wiki/Article.tsx b/components/wiki/Article.tsx
new file mode 100644
index 0000000..9e1d625
--- /dev/null
+++ b/components/wiki/Article.tsx
@@ -0,0 +1,22 @@
+import { ReactNode } from "react";
+
+interface ArticleProps {
+ title: string;
+ updatedAt?: string;
+ children: ReactNode
+}
+
+export default function Article({ title, updatedAt, children }: ArticleProps) {
+ return (
+
+
+
+ {children}
+
+ );
+}
\ No newline at end of file
diff --git a/data/wiki/pages/api.mdx b/data/wiki/pages/api.mdx
deleted file mode 100644
index ad6cc8e..0000000
--- a/data/wiki/pages/api.mdx
+++ /dev/null
@@ -1,6 +0,0 @@
----
-title: API
-updatedAt: "2026-08-05"
----
-
-comming soon...
\ No newline at end of file
diff --git a/lib/wiki.ts b/lib/wiki.ts
index c674267..df5e4df 100644
--- a/lib/wiki.ts
+++ b/lib/wiki.ts
@@ -1,6 +1,8 @@
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;
@@ -16,7 +18,6 @@ export async function getWikiPageBySlug(slug: string): Promise {
+ const filePath = path.join(dirPath, file);
+ const stat = fs.statSync(filePath);
+
+ if (stat && stat.isDirectory()) {
+ results = results.concat(getAllTsFiles(filePath));
+ } else if (filePath.endsWith('.ts') && !filePath.endsWith('.d.ts')) {
+ results.push(filePath);
+ }
+ });
+
+ 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 {
+ try {
+ const apiBasePath = path.join(process.cwd(), "app/api");
+ const allTsFiles = getAllTsFiles(apiBasePath);
+ 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 [];
+ }
}
\ No newline at end of file
diff --git a/package.json b/package.json
index d2a1b2d..07d388a 100644
--- a/package.json
+++ b/package.json
@@ -38,7 +38,7 @@
"eslint": "^9",
"eslint-config-next": "16.2.9",
"tailwindcss": "^4",
- "typescript": "^5"
+ "typescript": "^5.9.3"
},
"pnpm": {
"onlyBuiltDependencies": [
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index bbd6d8a..378fefb 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -91,7 +91,7 @@ importers:
specifier: ^4
version: 4.3.1
typescript:
- specifier: ^5
+ specifier: ^5.9.3
version: 5.9.3
packages:
diff --git a/types/api.ts b/types/api.ts
new file mode 100644
index 0000000..74a8573
--- /dev/null
+++ b/types/api.ts
@@ -0,0 +1,10 @@
+export interface ApiMethod {
+ method: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | string;
+ description: string;
+}
+
+export interface ApiRoute {
+ category: string;
+ route: string;
+ methods: ApiMethod[];
+}
\ No newline at end of file