docs: add question enhancement API swagger

Co-authored-by: shl0501 <[email protected]>
Co-authored-by: 유영재 <[email protected]>

apps/server/src/ai/ai.controller.ts

@@ -1,14 +1,18 @@
 import { Body, Controller, Post, UseGuards } from '@nestjs/common';
+import { ApiBody } from '@nestjs/swagger';
 
 import { AiService } from './ai.service';
 import { ImproveQuestionDto } from './dto/improve-question.dto';
+import { ImproveQuestionSwagger } from './swagger/improve-question.swagger';
 
 import { SessionTokenValidationGuard } from '@common/guards/session-token-validation.guard';
 @Controller('ai')
 export class AiController {
   constructor(private readonly aiService: AiService) {}
 
   @Post('question-improve')
+  @ImproveQuestionSwagger()
+  @ApiBody({ type: ImproveQuestionDto })
   @UseGuards(SessionTokenValidationGuard)
   public async improveQuestion(@Body() improveQuestionDto: ImproveQuestionDto) {
     const { body: userContent } = improveQuestionDto;

apps/server/src/ai/dto/improve-question.dto.ts

@@ -5,7 +5,7 @@ import { BaseDto } from '@common/base.dto';
 
 export class ImproveQuestionDto extends BaseDto {
   @ApiProperty({
-    example: '이것은 질문의 내용입니다.',
+    example: '리마큐가 뭐임?',
     description: '질문 본문 내용',
     required: true,
   })

apps/server/src/ai/swagger/improve-question.swagger.ts

@@ -0,0 +1,18 @@
+import { applyDecorators } from '@nestjs/common';
+import { ApiOperation, ApiResponse } from '@nestjs/swagger';
+
+export const ImproveQuestionSwagger = () =>
+  applyDecorators(
+    ApiOperation({ summary: '질문 개선' }),
+    ApiResponse({
+      status: 201,
+      description: '질문 개선 성공',
+      schema: {
+        example: {
+          result: {
+            question: '리마큐(Remacu)란 무엇인가요?',
+          },
+        },
+      },
+    }),
+  );