♻️ refactor: api 명세 추가

boostcampwm-2024 · Nov 21, 2024 · 7e7188b · 7e7188b
1 parent 8850d2a
commit 7e7188b
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/BE/src/asset/asset.controller.ts b/BE/src/asset/asset.controller.ts
@@ -26,6 +26,7 @@ export class AssetController {
   @ApiResponse({
     status: 200,
     description: '매도 가능 주식 개수 조회 성공',
+    example: { quantity: 0 },
   })
   async getUserStockByCode(
     @Req() request: Request,
@@ -48,6 +49,7 @@ export class AssetController {
   @ApiResponse({
     status: 200,
     description: '매수 가능 금액 조회 성공',
+    example: { cash_balance: 0 },
   })
   async getCashBalance(@Req() request: Request) {
     return this.assetService.getCashBalance(parseInt(request.user.userId, 10));

diff --git a/BE/src/auth/auth.controller.ts b/BE/src/auth/auth.controller.ts
@@ -10,7 +10,7 @@ import {
   UnauthorizedException,
 } from '@nestjs/common';
 import { AuthGuard } from '@nestjs/passport';
-import { ApiOperation } from '@nestjs/swagger';
+import { ApiOperation, ApiResponse } from '@nestjs/swagger';
 import { Request, Response } from 'express';
 import { ConfigService } from '@nestjs/config';
 import { AuthService } from './auth.service';
@@ -84,6 +84,11 @@ export class AuthController {
   @ApiOperation({ summary: '로그인 상태 확인 API' })
   @Get('/check')
   @UseGuards(AuthGuard('jwt'))
+  @ApiResponse({
+    status: 200,
+    description: '로그인 상태 조회 성공',
+    example: { isLogin: true },
+  })
   check() {
     return { isLogin: true };
   }