From 3fc0697db84ff4c2beb6c9afa18d67588403f518 Mon Sep 17 00:00:00 2001 From: Robin Schanbacher Date: Thu, 6 Aug 2026 17:39:51 +0200 Subject: [PATCH] chore: wiki: automatic list of all api endpoints --- app/api/songbooks/route.ts | 4 +- app/api/songs/[id]/route.ts | 1 + app/api/songs/attach/route.ts | 1 + app/api/songs/remove/route.ts | 1 + app/api/songs/route.ts | 3 + app/api/stream/currentID/route.ts | 2 + app/wiki/api/page.tsx | 63 ++++++------ lib/wiki.ts | 155 +++++++++++++++++++++++++++++- package.json | 2 +- pnpm-lock.yaml | 2 +- types/api.ts | 10 ++ 11 files changed, 205 insertions(+), 39 deletions(-) create mode 100644 types/api.ts diff --git a/app/api/songbooks/route.ts b/app/api/songbooks/route.ts index 124a7b3..b7e4b88 100644 --- a/app/api/songbooks/route.ts +++ b/app/api/songbooks/route.ts @@ -1,7 +1,7 @@ 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 +10,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..426ab1c 100644 --- a/app/api/songs/[id]/route.ts +++ b/app/api/songs/[id]/route.ts @@ -1,6 +1,7 @@ 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..c4040e7 100644 --- a/app/api/songs/attach/route.ts +++ b/app/api/songs/attach/route.ts @@ -1,6 +1,7 @@ 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..4702402 100644 --- a/app/api/songs/remove/route.ts +++ b/app/api/songs/remove/route.ts @@ -1,6 +1,7 @@ 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..7276bb8 100644 --- a/app/api/songs/route.ts +++ b/app/api/songs/route.ts @@ -2,6 +2,7 @@ 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 +11,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..3d33fab 100644 --- a/app/api/stream/currentID/route.ts +++ b/app/api/stream/currentID/route.ts @@ -8,10 +8,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/api/page.tsx b/app/wiki/api/page.tsx index 6443374..84618bf 100644 --- a/app/wiki/api/page.tsx +++ b/app/wiki/api/page.tsx @@ -1,41 +1,34 @@ -import Article from "@/components/wiki/Article"; -import { API, Callout } from "@/components/mdx-components" +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); -export default function Page() { return (
- - Es ist weder eine Authentifikation noch ein API-Key erforderlich. - - -

Stream

+ {Object.entries(groupedApis).map(([category, apis]) => ( +
+ {/* Kategorie-Überschrift wird nur EINMAL pro Kategorie gerendert */} +

+ {category} +

- - Jetziges angezeigtes Lied abrufen - - - Lied zum Anzeigen festlegen - - -

Lieder

- - - Informationen eines Liedes abrufen - - - Lied zu einem Liederbuch hinzufügen - - - Lied von einem Liederbuch entfernen - - -

Liederbücher

- - Liste aller Liederbücher abrufen - - - Neues Liederbuch erstellen - + {/* 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/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