feat: add initial swagger docs (#8)

package.json

@@ -29,6 +29,7 @@
     "@nestjs/mongoose": "^10.0.1",
     "@nestjs/passport": "^10.0.0",
     "@nestjs/platform-express": "^10.0.0",
+    "@nestjs/swagger": "^7.1.10",
     "bcrypt": "^5.1.1",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.0",

src/app.controller.ts

@@ -1,7 +1,9 @@
 import { Controller, Get } from '@nestjs/common';
 import { AppService } from './app.service';
 import { ExceptionService } from './shared';
+import { ApiTags } from '@nestjs/swagger';
 
+@ApiTags('root')
 @Controller()
 export class AppController {
   constructor(

src/main.ts

@@ -2,6 +2,7 @@ import { NestFactory } from '@nestjs/core';
 import { AppModule } from './app.module';
 import { ValidationPipe } from '@nestjs/common';
 import { HttpExceptionsFilter } from './http-exceptions.filter';
+import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';
 import * as cookieParser from 'cookie-parser';
 
 async function bootstrap() {
@@ -14,6 +15,16 @@ async function bootstrap() {
   );
   app.use(cookieParser());
   app.useGlobalFilters(new HttpExceptionsFilter());
+
+  const config = new DocumentBuilder()
+    .setTitle('EverREST')
+    .setDescription('EverREST API description')
+    .setVersion('0.0.0')
+    .build();
+  const document = SwaggerModule.createDocument(app, config);
+  // TODO: Add swagger 'ApiProperty' to DTOs
+  SwaggerModule.setup('docs/swagger', app, document);
+
   await app.listen(process.env.PORT || 3000);
 }
 bootstrap();

src/modules/shop/cart/carts.controller.ts

@@ -12,6 +12,9 @@ import { CartsService } from './carts.service';
 import { CurrentUser, CurrentUserInterceptor, JwtGuard } from 'src/shared';
 import { UserPayload } from 'src/interfaces';
 import { AddProductToCartDto, ProductIdDto } from '../dtos';
+import { ApiTags } from '@nestjs/swagger';
+
+@ApiTags('cart')
 @Controller('shop/cart')
 @UseGuards(JwtGuard)
 @UseInterceptors(CurrentUserInterceptor)

src/modules/shop/product/products.controller.ts

@@ -21,7 +21,9 @@ import {
 import { CurrentUser, CurrentUserInterceptor, JwtGuard } from 'src/shared';
 import { UserPayload } from 'src/interfaces';
 import { MongooseValidatorService } from 'src/shared/mongoose-validator.service';
+import { ApiTags } from '@nestjs/swagger';
 
+@ApiTags('products')
 @Controller('shop/products')
 export class ProductsController {
   constructor(

src/modules/user/auth/auth.controller.ts

@@ -22,7 +22,9 @@ import { LocalAuthGuard, RefreshJwtGuard } from './guards';
 import { Response } from 'express';
 import { CurrentUser, CurrentUserInterceptor, JwtGuard } from 'src/shared';
 import { UserPayload } from 'src/interfaces';
+import { ApiTags } from '@nestjs/swagger';
 
+@ApiTags('auth')
 @Controller('auth')
 export class AuthController {
   constructor(private authService: AuthService) {}