feat: swagger로 api 문서화

nest-cli.json

@@ -3,6 +3,14 @@
   "collection": "@nestjs/schematics",
   "sourceRoot": "src",
   "compilerOptions": {
-    "deleteOutDir": true
+    "deleteOutDir": true,
+    "plugins": [
+      {
+        "name": "@nestjs/swagger",
+        "options": {
+          "introspectComments": true
+        }
+      }
+    ]
   }
 }

package.json

@@ -25,6 +25,7 @@
     "@nestjs/core": "^10.0.0",
     "@nestjs/mongoose": "^10.0.0",
     "@nestjs/platform-express": "^10.0.0",
+    "@nestjs/swagger": "^7.1.2",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.0",
     "mongoose": "^7.3.4",

src/buildings/dtos/create-building.dto.ts

@@ -6,11 +6,4 @@ export class CreateBuildingDto {
 
   @IsString()
   readonly buildingName: string;
-
-  status: {
-    regular: number;
-    bottle: number;
-    plastic: number;
-    paper: number;
-  };
 }

src/buildings/floors/floors.controller.ts

@@ -1,10 +1,18 @@
 import { Body, Controller, Param, Post } from '@nestjs/common';
 import { FloorsService } from './floors.service';
+import { ApiBody } from '@nestjs/swagger';
 
 @Controller()
 export class FloorsController {
   constructor(private readonly floorsService: FloorsService) {}
 
+  @ApiBody({
+    schema: {
+      properties: {
+        floorNumber: { type: 'number' },
+      },
+    },
+  })
   @Post('/buildings/:buildingNumber/floors')
   createFloor(
     @Param('buildingNumber') buildingNumber: number,

src/main.ts

@@ -1,6 +1,7 @@
 import { NestFactory } from '@nestjs/core';
 import { AppModule } from './app.module';
 import { ValidationPipe } from '@nestjs/common';
+import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
 
 async function bootstrap() {
   const app = await NestFactory.create(AppModule);
@@ -13,6 +14,13 @@ async function bootstrap() {
     }),
   );
 
+  const config = new DocumentBuilder()
+    .setTitle('Trashcan API')
+    .setDescription('쓰레기통 API 입니다.')
+    .build();
+  const document = SwaggerModule.createDocument(app, config);
+  SwaggerModule.setup('docs', app, document);
+
   await app.listen(3000);
 }
 bootstrap();