refactor: revise the document according to the OpenAPI specifications

src/auth/auth.controller.ts

@@ -11,15 +11,15 @@ import {
   ApiUnauthorizedResponse,
 } from "@nestjs/swagger";
 import { Request } from "express";
+import { BadRequestError } from "src/error/bad-request-error";
+import { ConflictError } from "src/error/conflict-error";
+import { ForbiddenError } from "src/error/forbidden-error";
+import { UnauthorizedError } from "src/error/unauthorized-error";
 import { CreateUserDto } from "src/user/dto/create-user.dto";
 import { LoginUserDto } from "src/user/dto/login-user.dto";
-import { CreateUserBadRequestError } from "src/user/exceptions/create-user-badrequest-error.exception";
-import { CreateUserConflictError } from "src/user/exceptions/create-user-conflict-error.exception";
 import { CreateUserResponse } from "src/user/responses/create-user-response";
 
 import { AuthService } from "./auth.service";
-import { ForbiddenError } from "./exception/ForbiddenError";
-import { UnauthorizedError } from "./exception/UnauthorizedError";
 import { type JwtUser } from "./jwt/jwt.interface";
 import { JwtRefreshGuard } from "./jwt/jwt-refresh.guard";
 import { LocalAuthGuard } from "./local/local-auth.guard";
@@ -41,11 +41,11 @@ export class AuthController {
   })
   @ApiConflictResponse({
     description: "使用者資料重覆",
-    type: CreateUserConflictError,
+    type: ConflictError,
   })
   @ApiBadRequestResponse({
     description: "使用者格式不符",
-    type: CreateUserBadRequestError,
+    type: BadRequestError,
   })
   async register(@Body() userDto: CreateUserDto) {
     return this.authService.register(userDto);

src/auth/responses/generate-token.response.ts

@@ -19,7 +19,7 @@ export class GenerateTokenResponse {
 
   @ApiProperty({
     description: "HTTP Code",
-    example: "201",
+    example: 201,
     type: "number",
   })
   public readonly statusCode: number;

src/error/bad-request-error.ts

@@ -0,0 +1,17 @@
+import { ApiProperty } from "@nestjs/swagger";
+
+export class BadRequestError {
+  @ApiProperty({
+    description: "HTTP Code",
+    example: 400,
+    type: "number",
+  })
+  public readonly statusCode: number;
+
+  @ApiProperty({
+    description: "Error Message",
+    example: ["Error Message"],
+    type: "array",
+  })
+  public readonly error: string[];
+}

src/error/conflict-error.ts

@@ -0,0 +1,17 @@
+import { ApiProperty } from "@nestjs/swagger";
+
+export class ConflictError {
+  @ApiProperty({
+    description: "HTTP Code",
+    example: 409,
+    type: "number",
+  })
+  public readonly statusCode: number;
+
+  @ApiProperty({
+    description: "Error Message",
+    example: ["Error Message"],
+    type: "array",
+  })
+  public readonly error: string[];
+}

src/auth/exception/ForbiddenError.ts → src/error/forbidden-error.ts

@@ -3,15 +3,15 @@ import { ApiProperty } from "@nestjs/swagger";
 export class ForbiddenError {
   @ApiProperty({
     description: "HTTP Code",
-    example: "403",
+    example: 403,
     type: "number",
   })
   public readonly statusCode: number;
 
   @ApiProperty({
-    description: "Error message",
-    example: "Forbidden",
+    description: "Error Message",
+    example: "Error Message",
     type: "string",
   })
-  public readonly message: string;
+  public readonly error: string;
 }

src/auth/exception/UnauthorizedError.ts → src/error/unauthorized-error.ts

@@ -3,15 +3,15 @@ import { ApiProperty } from "@nestjs/swagger";
 export class UnauthorizedError {
   @ApiProperty({
     description: "HTTP Code",
-    example: "401",
+    example: 401,
     type: "number",
   })
   public readonly statusCode: number;
 
   @ApiProperty({
-    description: "Error message",
+    description: "Error Message",
     example: "Unauthorized",
     type: "string",
   })
-  public readonly message: string;
+  public readonly error: string;
 }

src/user/responses/create-user-response.ts

@@ -3,15 +3,15 @@ import { ApiProperty } from "@nestjs/swagger";
 export class CreateUserResponse {
   @ApiProperty({
     description: "HTTP 回應代碼",
-    example: "201",
+    example: 201,
     type: "number",
   })
   public readonly statusCode: number;
 
   @ApiProperty({
     description: "創建成功回應",
     example: "創建成功",
-    type: "number",
+    type: "string",
   })
   public readonly message: string;
 }