feat: add route documentation for languages and stats controllers

Author: pphatdev

src/controllers/languages.ts

@@ -6,6 +6,23 @@ export class LanguageController {
     private static githubClient: GitHubClient;
     private static cache: Map<string, { data: string; timestamp: number }>;
     private static CACHE_DURATION: number;
+    static routeDocs = {
+        requiredParams: ['username'],
+        optionalParams: [
+            'theme',
+            'show_info',
+            'top',
+            'variant',
+            'type',
+            'bgColor',
+            'borderColor',
+            'textColor',
+            'titleColor',
+            'format'
+        ],
+        payload: null as null,
+        example: '/languages?username=pphatdev&theme=default'
+    };
 
     static initialize(githubClient: GitHubClient, cache: Map<string, { data: string; timestamp: number }>, cacheDuration: number) {
         this.githubClient = githubClient;

src/controllers/stats.ts

@@ -8,6 +8,28 @@ export class StatsController {
     private static CACHE_DURATION: number;
     private static pendingRequests: Map<string, Promise<string>> = new Map();
     private static pngCache: Map<string, { data: Buffer; timestamp: number }> = new Map();
+    static routeDocs = {
+        requiredParams: ['username'],
+        optionalParams: [
+            'theme',
+            'hide_title',
+            'hide_border',
+            'hide_rank',
+            'show_icons',
+            'avatar_mode',
+            'show_avatar',
+            'custom_title',
+            'data_border_style',
+            'data_border_frame',
+            'bgColor',
+            'borderColor',
+            'textColor',
+            'titleColor',
+            'format'
+        ],
+        payload: null as null,
+        example: '/stats?username=pphatdev&theme=dark'
+    };
 
     static initialize(githubClient: GitHubClient, cache: Map<string, { data: string; timestamp: number }>, cacheDuration: number) {
         this.githubClient = githubClient;

src/index.ts

@@ -17,6 +17,63 @@ app.use(cors());
 app.use(express.static(publicDir));
 app.use('/public', express.static(publicDir));
 
+const staticRoots = ['/', '/public'];
+
+type RouteInfo = {
+    method: string;
+    path: string;
+    requiredParams?: string[];
+    optionalParams?: string[];
+    payload?: string | null;
+    example?: string;
+};
+
+const routeDocs: Record<string, Omit<RouteInfo, 'method' | 'path'>> = {
+    'GET /stats': StatsController.routeDocs,
+    'GET /languages': LanguageController.routeDocs
+};
+
+const getRoutes = (): RouteInfo[] => {
+    const routes: RouteInfo[] = [];
+    const router = (app as { _router?: { stack?: Array<{ route?: { path?: string; methods?: Record<string, boolean> } } | { name?: string; handle?: { stack?: Array<{ route?: { path?: string; methods?: Record<string, boolean> } }> } }> } })._router;
+    const stack = router?.stack ?? [];
+
+    for (const layer of stack) {
+        if ('route' in layer && layer.route) {
+            const path = layer.route.path ?? '';
+            const methods = Object.keys(layer.route.methods ?? {}).filter((method) => layer.route?.methods?.[method]);
+            for (const method of methods) {
+                const routeKey = `${method.toUpperCase()} ${path}`;
+                routes.push({ method: method.toUpperCase(), path, ...routeDocs[routeKey] });
+            }
+        } else if ('name' in layer && layer.name === 'router' && layer.handle?.stack) {
+            for (const nestedLayer of layer.handle.stack) {
+                if (nestedLayer.route) {
+                    const path = nestedLayer.route.path ?? '';
+                    const methods = Object.keys(nestedLayer.route.methods ?? {}).filter((method) => nestedLayer.route?.methods?.[method]);
+                    for (const method of methods) {
+                        const routeKey = `${method.toUpperCase()} ${path}`;
+                        routes.push({ method: method.toUpperCase(), path, ...routeDocs[routeKey] });
+                    }
+                }
+            }
+        }
+    }
+
+    routes.sort((a, b) => a.path.localeCompare(b.path) || a.method.localeCompare(b.method));
+    return routes;
+};
+
+app.get('/', (_req, res) => {
+    res.json({
+        routes: getRoutes(),
+        staticAssets: {
+            roots: staticRoots,
+            example: '/sitemap.xml'
+        }
+    });
+});
+
 const PORT = process.env.PORT || 3000;
 const APP_ENV = process.env.APP_ENV || 'development';
 const PROTOCOL = APP_ENV === 'production' ? 'https' : 'http';