Merge pull request #102 from boostcampwm-2024/feat/#77/init-swagger

[Feat] swagger 세팅

apps/api/package.json

@@ -23,15 +23,18 @@
     "@nestjs/common": "^10.0.0",
     "@nestjs/core": "^10.0.0",
     "@nestjs/platform-express": "^10.0.0",
-    "reflect-metadata": "^0.2.0",
-    "rxjs": "^7.8.1",
+    "@nestjs/swagger": "^8.0.1",
     "@repo/shards": "workspace:*",
-    "@repo/types": "workspace:*"
+    "@repo/types": "workspace:*",
+    "reflect-metadata": "^0.2.0",
+    "rxjs": "^7.8.1"
   },
   "devDependencies": {
     "@nestjs/cli": "^10.0.0",
     "@nestjs/schematics": "^10.0.0",
     "@nestjs/testing": "^10.0.0",
+    "@repo/lint": "workspace:*",
+    "@repo/tsconfig": "workspace:*",
     "@types/express": "^5.0.0",
     "@types/jest": "^29.5.2",
     "@types/node": "^20.3.1",
@@ -49,9 +52,7 @@
     "ts-loader": "^9.4.3",
     "ts-node": "^10.9.1",
     "tsconfig-paths": "^4.2.0",
-    "typescript": "^5.1.3",
-    "@repo/lint": "workspace:*",
-    "@repo/tsconfig": "workspace:*"
+    "typescript": "^5.1.3"
   },
   "jest": {
     "moduleFileExtensions": [

apps/api/src/app.controller.ts

@@ -1,4 +1,5 @@
 import { Controller, Get } from '@nestjs/common';
+import { ApiOperation, ApiResponse } from '@nestjs/swagger';
 
 import { AppService } from './app.service';
 
@@ -7,6 +8,8 @@ export class AppController {
   constructor(private readonly appService: AppService) {}
 
   @Get()
+  @ApiOperation({ summary: 'swaggerTest' })
+  @ApiResponse({ status: 200, description: '기본 존재하는 api Test.' })
   getHello(): string {
     return this.appService.getHello();
   }

apps/api/src/main.ts

@@ -1,11 +1,21 @@
 import { NestFactory } from '@nestjs/core';
+import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
 
 import { AppModule } from '@/app.module';
 
 async function bootstrap() {
   const app = await NestFactory.create(AppModule);
-  app.setGlobalPrefix('api');
+
+  //swagger setting
+  const config = new DocumentBuilder()
+    .setTitle('Ticle API server')
+    .setDescription('API 서버의 api 문서입니다.')
+    .setVersion('1.0')
+    .build();
+  const document = SwaggerModule.createDocument(app, config);
+  SwaggerModule.setup('api-doc', app, document);
 
+  app.setGlobalPrefix('api');
   await app.listen(process.env.PORT ?? 3000);
 }
 bootstrap();