feat: 🎸 add main api doc

yeukfei02 · Apr 20, 2022 · e03f4d2 · e03f4d2
1 parent fa43eec
commit e03f4d2
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/src/app.controller.ts b/src/app.controller.ts
@@ -1,11 +1,19 @@
 import { Controller, Get } from '@nestjs/common';
 import { AppService } from './app.service';
 
+import { ApiResponse } from '@nestjs/swagger';
+import { GetMainResponse } from './response/getMain.response';
+
 @Controller()
 export class AppController {
   constructor(private readonly appService: AppService) {}
 
   @Get()
+  @ApiResponse({
+    status: 200,
+    description: 'Successful response',
+    type: GetMainResponse,
+  })
   getMain(): any {
     const response = this.appService.getMain();
     return response;

diff --git a/src/response/getMain.response.ts b/src/response/getMain.response.ts
@@ -0,0 +1,6 @@
+import { ApiProperty } from '@nestjs/swagger';
+
+export class GetMainResponse {
+  @ApiProperty()
+  message: string;
+}