Fixed Swagger GUI page

Author: popov654

src/article/article.controller.ts

@@ -1,5 +1,5 @@
 import { Body, Controller, Delete, Get, Param, Post, Put, Query } from '@nestjs/common';
-import { ApiBearerAuth, ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger';
+import { ApiBearerAuth, ApiBody, ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger';
 import { User } from '../user/user.decorator';
 import { IArticleRO, IArticlesRO, ICommentsRO } from './article.interface';
 import { ArticleService } from './article.service';
@@ -38,18 +38,20 @@ export class ArticleController {
   }
 
   @ApiOperation({ summary: 'Create article' })
+  @ApiBody({ type: CreateArticleDto })
   @ApiResponse({ status: 201, description: 'The article has been successfully created.' })
   @ApiResponse({ status: 403, description: 'Forbidden.' })
   @Post()
-  async create(@User('id') userId: number, @Body('article') articleData: CreateArticleDto) {
+  async create(@User('id') userId: number, @Body() articleData: CreateArticleDto) {
     return this.articleService.create(userId, articleData);
   }
 
   @ApiOperation({ summary: 'Update article' })
+  @ApiBody({ type: CreateArticleDto })
   @ApiResponse({ status: 201, description: 'The article has been successfully updated.' })
   @ApiResponse({ status: 403, description: 'Forbidden.' })
   @Put(':slug')
-  async update(@User('id') user: number, @Param() params, @Body('article') articleData: CreateArticleDto) {
+  async update(@User('id') user: number, @Param() params, @Body() articleData: CreateArticleDto) {
     // Todo: update slug also when title gets changed
     return this.articleService.update(+user, params.slug, articleData);
   }
@@ -63,10 +65,11 @@ export class ArticleController {
   }
 
   @ApiOperation({ summary: 'Create comment' })
+  @ApiBody({ type: CreateCommentDto })
   @ApiResponse({ status: 201, description: 'The comment has been successfully created.' })
   @ApiResponse({ status: 403, description: 'Forbidden.' })
   @Post(':slug/comments')
-  async createComment(@User('id') user: number, @Param('slug') slug, @Body('comment') commentData: CreateCommentDto) {
+  async createComment(@User('id') user: number, @Param('slug') slug, @Body() commentData: CreateCommentDto) {
     return this.articleService.addComment(user, slug, commentData);
   }
 

src/article/dto/create-article.dto.ts

@@ -1,6 +1,12 @@
+import { ApiProperty } from '@nestjs/swagger';
+
 export class CreateArticleDto {
+  @ApiProperty()
   readonly title!: string;
+  @ApiProperty()
   readonly description!: string;
+  @ApiProperty()
   readonly body!: string;
+  @ApiProperty()
   readonly tagList!: string[];
 }

src/article/dto/create-comment.ts

@@ -1,3 +1,6 @@
+import { ApiProperty } from '@nestjs/swagger';
+
 export class CreateCommentDto {
+  @ApiProperty()
   readonly body!: string;
 }

src/user/dto/create-user.dto.ts

@@ -1,13 +1,17 @@
+import { ApiProperty } from '@nestjs/swagger';
 import { IsNotEmpty } from 'class-validator';
 
 export class CreateUserDto {
 
   @IsNotEmpty()
+  @ApiProperty()
   readonly username!: string;
 
   @IsNotEmpty()
+  @ApiProperty()
   readonly email!: string;
 
   @IsNotEmpty()
+  @ApiProperty()
   readonly password!: string;
 }

src/user/dto/login-user.dto.ts

@@ -1,10 +1,13 @@
+import { ApiProperty } from '@nestjs/swagger';
 import { IsNotEmpty } from 'class-validator';
 
 export class LoginUserDto {
 
   @IsNotEmpty()
+  @ApiProperty()
   readonly email!: string;
 
   @IsNotEmpty()
+  @ApiProperty()
   readonly password!: string;
 }

src/user/dto/update-user.dto.ts

@@ -1,6 +1,12 @@
+import { ApiProperty } from '@nestjs/swagger';
+
 export class UpdateUserDto {
+  @ApiProperty()
   readonly bio!: string;
+  @ApiProperty()
   readonly email!: string;
+  @ApiProperty()
   readonly image!: string;
+  @ApiProperty()
   readonly username!: string;
 }

src/user/user.controller.ts

@@ -7,7 +7,9 @@ import { UserService } from './user.service';
 
 import {
   ApiBearerAuth,
+  ApiBody,
   ApiTags,
+  getSchemaPath
 } from '@nestjs/swagger';
 
 @ApiBearerAuth()
@@ -28,8 +30,9 @@ export class UserController {
   }
 
   @UsePipes(new ValidationPipe())
+  @ApiBody({ schema: { type: 'object', items: { type: 'object', items: { $ref: getSchemaPath(CreateUserDto) } } } })
   @Post('users')
-  async create(@Body('user') userData: CreateUserDto) {
+  async create(@Body() userData: CreateUserDto) {
     return this.userService.create(userData);
   }
 
@@ -39,6 +42,7 @@ export class UserController {
   }
 
   @UsePipes(new ValidationPipe())
+  @ApiBody({ schema: { type: 'object', items: { type: 'object', items: { $ref: getSchemaPath(LoginUserDto) } } } })
   @Post('users/login')
   async login(@Body('user') loginUserDto: LoginUserDto): Promise<IUserRO> {
     const foundUser = await this.userService.findOne(loginUserDto);
@@ -53,3 +57,4 @@ export class UserController {
     return { user };
   }
 }
+