📝 update api docs and fix http status code #114

update api docs and fix http status code #114

backend/src/v3/lent/lent.controller.ts

@@ -25,21 +25,16 @@ export class LentController {
   @ApiCreatedResponse({
     description: '대여에 성공 시, 201 Created를 응답합니다.',
   })
-  @ApiNotFoundResponse({
-    description: '해당 캐비넷이나 유저가 존재하지 않으면, 404 Not Found를 응답합니다.',
-  })
   @ApiBadRequestResponse({
-    description:
-      '이미 대여중인 사물함이 있는 경우, 400 Bad Request를 응답합니다.',
+    description:'해당 캐비넷이나 유저가 존재하지 않는 경우 or 해당 유저가 이미 대여중인 사물함이 있는 경우, 400 Bad Request를 응답합니다.',
   })
   @ApiResponse({
     status: HttpStatus.I_AM_A_TEAPOT,
     description:
       "동아리 사물함을 대여 시도한 경우, 418 I'm a teapot을 응답합니다.",
   })
   @ApiConflictResponse({
-    description: `잔여 자리가 없는 경우, 연체 사물함을 대여 시도한 경우,
-      임시 밴 사물함이나 고장 사물함을 대여 시도한 경우 409 Conflict를 응답합니다.`,
+    description: '해당 캐비넷에 잔여 자리가 없는 경우 or 연체 사물함을 대여 시도한 경우 or 임시 밴 사물함이나 고장 사물함을 대여 시도한 경우, 409 Conflict를 응답합니다.',
   })
   @Post('/cabinet/:cabinet_id/:user_id')
   @HttpCode(HttpStatus.CREATED)

backend/src/v3/lent/lent.service.ts

@@ -25,14 +25,14 @@ export class LentService {
       if (!user) {
         throw new HttpException(
           `🚨 해당 유저가 존재하지 않습니다. 🚨`,
-          HttpStatus.NOT_FOUND,
+          HttpStatus.BAD_REQUEST,
         );
       }
       // 캐비넷이 존재하는지 확인
       if (!await this.cabinetService.isCabinetExist(cabinet_id)) {
         throw new HttpException(
           `🚨 해당 캐비넷이 존재하지 않습니다. 🚨`,
-          HttpStatus.NOT_FOUND,
+          HttpStatus.BAD_REQUEST,
         );
       }
       // 유저가 대여한 사물함 확인

backend/src/v3/return/return.component.ts

@@ -18,7 +18,6 @@ export class ReturnTools {
     @Inject('IReturnRepository')
     private returnRepository: IReturnRepository,
     private cabinetService: CabinetService,
-    @Inject(forwardRef(() => ReturnService))
     private banService: BanService,
   ) {}
 

backend/src/v3/return/return.controller.ts

@@ -27,12 +27,9 @@ export class ReturnController {
   @ApiNoContentResponse({
     description: '반납에 성공 시, 204 No Content를 응답합니다.',
   })
-  @ApiNotFoundResponse({
-    description: '해당 유저가 존재하지 않으면, 404 Not Found를 응답합니다.',
-  })
   @ApiBadRequestResponse({
     description:
-      '대여중인 사물함이 없는 경우, 400 Bad Request를 응답합니다.',
+      '해당 유저가 존재하지 않거나 대여중인 사물함이 없는 경우, 400 Bad Request를 응답합니다.',
   })
   @Delete('/user/:user_id')
   @HttpCode(HttpStatus.NO_CONTENT)
@@ -59,12 +56,9 @@ export class ReturnController {
   @ApiNoContentResponse({
     description: '반납에 성공 시, 204 No Content를 응답합니다.',
   })
-  @ApiNotFoundResponse({
-    description: '해당 캐비넷이 존재하지 않으면, 404 Not Found를 응답합니다.',
-  })
   @ApiBadRequestResponse({
     description:
-      '해당 사물함을 대여중인 유저가 없다면, 400 Bad Request를 응답합니다.',
+      '해당 캐비넷이 존재하지 않거나 해당 사물함을 대여중인 유저가 없다면, 400 Bad Request를 응답합니다.',
   })
   @Delete('/cabinet/:cabinet_id')
   @HttpCode(HttpStatus.NO_CONTENT)
@@ -93,8 +87,7 @@ export class ReturnController {
   })
   @ApiBadRequestResponse({
     type: ReturnBundleFailedResponseDto,
-    description: `대여중인 사물함이 없는 유저가 있거나 대여중인 유저가 없는 사물함이 있는 경우, 400 Bad Request를 응답합니다.
-      이때 response body로 처리에 실패한 user_id나 cabinet_id의 배열을 전달합니다.`,
+    description: '존재하지 않는 유저이거나 대여중인 사물함이 없는 유저가 포함되어 있는 경우 or 존재하지 않는 사물함이거나 유저가 대여중이지 않은 사물함이 포함되어 있는 경우, 400 Bad Request를 응답합니다. 이때 response body로 처리에 실패한 user_id나 cabinet_id의 배열을 전달합니다.',
   })
   @ApiBody({ type: ReturnBundleDataDto })
   @Delete('bundle/cabinet')
@@ -115,7 +108,7 @@ export class ReturnController {
       this.logger.debug(`Called ${this.returnBundle.name}`);
       return await this.returnService.returnBundle(users, cabinets);
     } catch (err) {
-      this.logger.error(err);
+      this.logger.error(err, err.response);
       if (err instanceof HttpException) {
         throw err;
       } else {

backend/src/v3/return/return.service.ts

@@ -15,8 +15,8 @@ export class ReturnService {
     @Inject('IReturnRepository') private returnRepository: IReturnRepository,
     private userService: UserService,
     private lentTools: LentTools,
-    @Inject(forwardRef(() => ReturnTools))
     private returnTools: ReturnTools,
+    private cabinetService: CabinetService,
   ) {}
 
   async returnUserCabinet(user_id: number): Promise<void> {
@@ -27,7 +27,7 @@ export class ReturnService {
       if (!user) {
         throw new HttpException(
           `🚨 해당 유저가 존재하지 않습니다. 🚨`,
-          HttpStatus.NOT_FOUND,
+          HttpStatus.BAD_REQUEST,
         );
       }
       // 1. 해당 유저가 대여중인 cabinet_id를 가져온다.
@@ -36,8 +36,8 @@ export class ReturnService {
       );
       if (cabinet_id === null) {
         throw new HttpException(
-          `${user.intra_id} doesn't lent cabinet!`,
-          HttpStatus.FORBIDDEN,
+          `🚨 해당 유저가 대여중인 사물함이 없습니다. 🚨`,
+          HttpStatus.BAD_REQUEST,
         );
       }
       const lent = await this.returnTools.returnStateTransition(
@@ -53,6 +53,13 @@ export class ReturnService {
   async returnCabinet(cabinet_id: number): Promise<void> {
     this.logger.debug(`Called ${ReturnService.name} ${this.returnCabinet.name}`);
     try {
+      // 캐비넷이 존재하는지 확인
+      if (!await this.cabinetService.isCabinetExist(cabinet_id)) {
+        throw new HttpException(
+          `🚨 해당 캐비넷이 존재하지 않습니다. 🚨`,
+          HttpStatus.BAD_REQUEST,
+        );
+      }
       const users = await this.returnRepository.getUsersByCabinetId(cabinet_id);
       if (users === null) {
         throw new HttpException(