swagger api doc

Author: vinodnextcoder

src/auth/auth.controller.spec.ts

@@ -83,7 +83,7 @@ describe("Auth Controller", () => {
 
  await controller.signIn(mockUserRequest, mockResponse);
 
- expect(signInSpy).toHaveBeenCalledWith("te@test.com", "Password11@");
+ expect(signInSpy).toHaveBeenCalledWith("te@test.com", "Password1@");
  });
  });
 });

src/users/users.controller.ts

@@ -8,14 +8,52 @@ import {statusMessage} from '../constant/statusMessage'
 import { HttpExceptionFilter } from '../utils/http-exception.filter';
 import { responseData, userData } from '../interface/common';
 import { AuthGuard } from '../common/guards/at.guard';
-import { ApiResponse } from '@nestjs/swagger';
-
+import { ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger';
 
 
+@ApiTags('users')
 @Controller("v1/users")
 export class UserController {
  constructor(private readonly userService: UserService) {}
-
+ 
+ @ApiOperation({
+ summary: 'Create user',
+ description: 'User signup app',
+ })
+ @ApiResponse({ 
+ status: 200, 
+ description: 'Success! Returns the data.',
+ content: {
+ 'application/json': {
+ schema: {
+ type: 'object',
+ properties: {
+ statusCode: { type: 'number', example: 201 },
+ isSuccess: { type: 'boolean', example: true},
+ message: { type: 'string', example: 'Record Created' },
+ data: { type: 'object', example: 'Record Created' }
+ },
+ },
+ example: {
+ "statusCode": 201,
+ "isSuccess": true,
+ "message": "Record Created",
+ "data": {
+ "username": "test username",
+ "first_name": "pradip",
+ "last_name": "patil",
+ "email": "pradip@test.com",
+ "email_code": "DAQJ1",
+ "password": "4xeuIuIK3XGXHX3xtMBAM4uYeWlWsOg8RC",
+ "password_reset_code": "122222",
+ "createdAt": "2023-12-22T04:45:45.710Z",
+ "updatedAt": "2023-12-22T04:45:45.710Z",
+ "_id": "6585147f97b06"
+ }
+ },
+ },
+ },
+ })
  @Public()
  @Post()
  @UseFilters(new HttpExceptionFilter())
@@ -27,13 +65,12 @@ export class UserController {
 
 // get user
 @ApiResponse({ status: 200, description: 'The record has been successfully fetch.'})
-  @ApiResponse({ status: 403, description: 'Forbidden.'})
+ @ApiResponse({ status: 403, description: 'Forbidden.'})
  @UseGuards(AuthGuard)
  @Get()
  @UseFilters(new HttpExceptionFilter())
  async findAll(): Promise<userData[]> {
  return this.userService.findAll();
  }
-
 }