Merge pull request #6 from wang-bam-bbang/docs

docs: update swagger docs

src/app.controller.ts

@@ -1,7 +1,13 @@
 import { Controller, Get } from '@nestjs/common';
+import { ApiOperation, ApiTags } from '@nestjs/swagger';
 
+@ApiTags('app')
 @Controller()
 export class AppController {
+  @ApiOperation({
+    summary: 'health check',
+    description: 'health check',
+  })
   @Get()
   getHello(): Record<string, any> {
     return {

src/comment/comment.controller.ts

@@ -24,7 +24,7 @@ import {
   ApiUnauthorizedResponse,
 } from '@nestjs/swagger';
 
-@ApiTags('comment')
+@ApiTags('Comment')
 @Controller('comment')
 export class CommentController {
   constructor(private commentService: CommentService) {}

src/image/image.controller.ts

@@ -15,12 +15,14 @@ import {
   ApiInternalServerErrorResponse,
   ApiOkResponse,
   ApiOperation,
+  ApiTags,
   ApiUnauthorizedResponse,
 } from '@nestjs/swagger';
 import { IdPGuard } from 'src/user/guard/idp.guard';
 import { GetUser } from 'src/user/decorator/get-user.decorator';
 import { User } from '@prisma/client';
 
+@ApiTags('Image')
 @Controller('image')
 export class ImageController {
   constructor(private imageService: ImageService) {}

src/post/post.controller.ts

@@ -28,7 +28,7 @@ import {
   ApiUnauthorizedResponse,
 } from '@nestjs/swagger';
 
-@ApiTags('post')
+@ApiTags('Post')
 @Controller('post')
 export class PostController {
   constructor(private postService: PostService) {}

src/user/user.controller.ts

@@ -26,7 +26,7 @@ import {
   ApiUnauthorizedResponse,
 } from '@nestjs/swagger';
 
-@ApiTags('user')
+@ApiTags('User')
 @Controller('user')
 export class UserController {
   constructor(private userService: UserService) {}