Merge pull request #7 from programeryk/feat-structured-logging-request-id

feat(api): add root API home endpoint with quick links to docs, healt…

Author: programeryk

src/app.controller.spec.ts

@@ -15,9 +15,13 @@ describe('AppController', () => {
   });
 
   describe('root', () => {
-    it('should return "This is the stateful engagement system!"', () => {
-      expect(appController.getHello()).toBe(
-        'This is the stateful engagement system!',
+    it('should return API home metadata and quick links', () => {
+      expect(appController.getHome()).toEqual(
+        expect.objectContaining({
+          name: 'Stateful Engagement Backend',
+          docs: '/api',
+          health: '/health',
+        }),
       );
     });
   });

src/app.controller.ts

@@ -6,7 +6,7 @@ export class AppController {
   constructor(private readonly appService: AppService) {}
 
   @Get()
-  getHello(): string {
-    return this.appService.getHello();
+  getHome() {
+    return this.appService.getApiHome();
   }
 }

src/app.service.ts

@@ -1,8 +1,35 @@
 import { Injectable } from '@nestjs/common';
 
+type EndpointGroup = {
+  name: string;
+  path: string;
+};
+
+type ApiHomeResponse = {
+  name: string;
+  message: string;
+  version: string;
+  docs: string;
+  health: string;
+  endpoints: EndpointGroup[];
+};
+
 @Injectable()
 export class AppService {
-  getHello(): string {
-    return 'This is the stateful engagement system!';
+  getApiHome(): ApiHomeResponse {
+    return {
+      name: 'Stateful Engagement Backend',
+      message: 'API is running. Open /api for Swagger and test endpoints.',
+      version: 'v1',
+      docs: '/api',
+      health: '/health',
+      endpoints: [
+        { name: 'Auth', path: '/auth' },
+        { name: 'Check-ins', path: '/checkins' },
+        { name: 'Tools', path: '/tools' },
+        { name: 'Rewards', path: '/rewards' },
+        { name: 'Profile', path: '/me' },
+      ],
+    };
   }
 }

test/app.e2e-spec.ts

@@ -24,6 +24,19 @@ describe('AppController (e2e)', () => {
     return request(app.getHttpServer())
       .get('/')
       .expect(200)
-      .expect('This is the stateful engagement system!');
+      .expect({
+        name: 'Stateful Engagement Backend',
+        message: 'API is running. Open /api for Swagger and test endpoints.',
+        version: 'v1',
+        docs: '/api',
+        health: '/health',
+        endpoints: [
+          { name: 'Auth', path: '/auth' },
+          { name: 'Check-ins', path: '/checkins' },
+          { name: 'Tools', path: '/tools' },
+          { name: 'Rewards', path: '/rewards' },
+          { name: 'Profile', path: '/me' },
+        ],
+      });
   });
 });