chore: wiki: automatic list of all api endpoints
This commit is contained in:
1 parent
7664d058df
commit
3fc0697db8
11 files changed
+205
-39
No files matched your search
+154
-1
@@ -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<WikiArticle | nul
|
||||
const fullPath = path.join(wikiDirectory, `${slug}.mdx`);
|
||||
const fileContents = fs.readFileSync(fullPath, "utf-8");
|
||||
|
||||
// Metadaten und Inhalt parsen
|
||||
const { data, content } = matter(fileContents);
|
||||
|
||||
return {
|
||||
@@ -29,4 +30,156 @@ export async function getWikiPageBySlug(slug: string): Promise<WikiArticle | nul
|
||||
} catch (error) {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
export function getAllTsFiles(dirPath: string): string[] {
|
||||
let results: string[] = [];
|
||||
|
||||
if (!fs.existsSync(dirPath)) return results;
|
||||
|
||||
const list = fs.readdirSync(dirPath);
|
||||
|
||||
list.forEach((file) => {
|
||||
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<ApiRoute[]> {
|
||||
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 [];
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user