swagger api doc

Author: vinodnextcoder

src/auth/auth.controller.ts

@@ -7,56 +7,67 @@ import {
  Res,
  UseFilters,
  UseGuards,
-} from '@nestjs/common';
-import { Response,Request } from 'express';
-import { AuthService } from './auth.service';
-import { Public } from './decorators/public.decorator';
-import { HttpExceptionFilter } from '../utils/http-exception.filter';
-import { AuthGuard } from '../common/guards/index';
-import { sendResponse } from '../utils/index';
-import { statusMessage } from '../constant/statusMessage';
+} from "@nestjs/common";
+import { Response, Request } from "express";
+import { AuthService } from "./auth.service";
+import { Public } from "./decorators/public.decorator";
+import { HttpExceptionFilter } from "../utils/http-exception.filter";
+import { AuthGuard } from "../common/guards/index";
+import {
+ sendResponse,
+ loginSuccessResponse,
+ loginErrorResponse,
+} from "../utils/index";
+import { statusMessage } from "../constant/statusMessage";
+import { ApiResponse } from "@nestjs/swagger";
 
-@Controller('auth')
+@Controller("auth")
 export class AuthController {
  constructor(private authService: AuthService) {}
 
+ @ApiResponse(loginSuccessResponse)
+ @ApiResponse(loginErrorResponse)
  @Public()
- @HttpCode(HttpStatus.OK)
- @Post('login')
+ @UseFilters(new HttpExceptionFilter())
+ @Post("login")
  async signIn(@Body() signInDto: Record<string, any>, @Res() res: Response) {
- const token = await this.authService.signIn(signInDto.email, signInDto.password);
- console.log(token)
+ const token = await this.authService.signIn(
+ signInDto.email,
+ signInDto.password
+ );
+ console.log(token);
 
- res.cookie('access_token',token.access_token,  {
+ res.cookie("access_token", token.access_token, {
  httpOnly: true,
  expires: new Date(Date.now() + 1 * 24 * 60 * 60 * 1000),
- path: '/',
- sameSite: 'none',
+ path: "/",
+ sameSite: "none",
  secure: true,
  });
- 
- res.cookie('refresh_token', token.refresh_token,  {
+
+ res.cookie("refresh_token", token.refresh_token, {
  httpOnly: true,
  expires: new Date(Date.now() + 1 * 24 * 60 * 60 * 1000),
- path: '/',
- sameSite: 'none',
+ path: "/",
+ sameSite: "none",
  secure: true,
  });
- return sendResponse(res,HttpStatus.OK,statusMessage[HttpStatus.OK],true,null);
+ return sendResponse(
+ res,
+ HttpStatus.OK,
+ statusMessage[HttpStatus.OK],
+ true,
+ null
+ );
  }
 
  // @Public()
  @UseGuards(AuthGuard)
- @Post('/refresh')
+ @Post("/refresh")
  @UseFilters(new HttpExceptionFilter())
- async refreshTokens(
- @Res() request:Request,
- @Res() res: Response
- ) {
+ async refreshTokens(@Res() request: Request, @Res() res: Response) {
  // console.log(request);
- return res.sendStatus(200)
+ return res.sendStatus(200);
  // return await this.authService.refreshTokens(userId, refreshToken);
  }
-
-
 }

src/utils/index.ts

@@ -173,4 +173,33 @@ export const loginSuccessResponse = {
  },
  },
  },
+};
+
+export const loginErrorResponse = {
+ status: 401,
+ description: "Success! Returns the user data.",
+ content: {
+ "application/json": {
+ schema: {
+ type: "object",
+ properties: {
+ statusCode: { type: "number", example: 400 },
+ isSuccess: { type: "boolean", example: false },
+ message: { type: "string", example: "Unauthorized" },
+ data: { type: "object", example: null },
+ timestamp: { type: "date", example: "2023-12-22T05:17:16.499Z" },
+ path: { type: "string", example: "/login" },
+ },
+ },
+ example: {
+ statusCode: 401,
+ message: "Unauthorized",
+ error: "Unauthorized",
+ timestamp: "2023-12-22T06:00:04.100Z",
+ path: "/auth/login",
+ isSuccess: false,
+ data: null,
+ },
+ },
+ },
 };