update swagger decoration

Author: daniwebdev

package.json

@@ -21,7 +21,7 @@
     "nest": "nest",
     "typeorm": "ts-node ./node_modules/typeorm/cli",
     "migration:run": "npm run typeorm migration:run -- -d ./migrations/datasource.ts",
-    "migration:create": "npm run typeorm -- migration:create ./src/migrations/$npm_config_name",
+    "migration:create": "npm run typeorm -- migration:create",
     "migration:revert": "npm run typeorm -- -d ./migrations/datasource.ts migration:revert"
   },
   "dependencies": {

src/apps/app.guard.ts

@@ -34,6 +34,7 @@ export class ApiKeyGuard implements CanActivate {
 
     const key = req.headers['x-api-key'] ?? req.query.api_key
 
+    console.log(req.headers);
     if(key == undefined || key == '') {
       throw new HttpException('X-API-KEY is not provided.', HttpStatus.UNAUTHORIZED);
     }

src/apps/auth/auth.controller.ts

@@ -6,18 +6,20 @@ import { AuthService } from './auth.service';
 import { LoginDTO } from './dto/login.dto';
 import { RegisterDTO } from './dto/register.dto';
 import { I18n, I18nContext } from 'nestjs-i18n';
-import { ApiTags } from '@nestjs/swagger';
+import { ApiBody, ApiHeader, ApiSecurity, ApiTags } from '@nestjs/swagger';
 
 @Controller('auth')
+@ApiTags("Auth")
+@ApiSecurity('api-key')
 export class AuthController {
 
     constructor(
         private authService: AuthService,
     ) {}
 
-    @ApiTags("Auth")
     @Post('/login')
     @HttpCode(HttpStatus.OK)
+    @ApiBody({type: LoginDTO})
     async login(
         @I18n() i18n: I18nContext,
         @Req() req: Request,

src/apps/auth/dto/coordinate.dto.ts

@@ -1,9 +1,12 @@
+import { ApiProperty } from "@nestjs/swagger";
 import { IsNumber } from "class-validator";
 
 export class CoordinateDTO {
+    @ApiProperty({example: 6.23499})
     @IsNumber()
     latitude: number;
 
+    @ApiProperty({example: -18.23499})
     @IsNumber()
     longitude: number;
 }

src/apps/auth/dto/device.dto.ts

@@ -1,17 +1,22 @@
+import { ApiProperty } from "@nestjs/swagger";
 import { IsNotEmpty } from "class-validator";
 
 enum PlatformEnum {Android, iOS, Desktop, Web}
 
 export class DeviceDTO {
+    @ApiProperty({example: 'we7r12i'})
     @IsNotEmpty()
     id: string;
-
+    
+    @ApiProperty({example: "Iphone 14 Pro Max"})
     @IsNotEmpty()
     name: string;
-
+    
+    @ApiProperty({example: "Apple"})
     @IsNotEmpty()
     brand: string;
-
+    
+    @ApiProperty({example: "iOS 17"})
     @IsNotEmpty()
     os: string;
 }

src/apps/auth/dto/login.dto.ts

@@ -1,15 +1,20 @@
+import { ApiProperty } from "@nestjs/swagger";
 import { IsNotEmpty } from "class-validator";
 import { CoordinateDTO } from "./coordinate.dto";
 import { DeviceDTO } from "./device.dto";
 export class LoginDTO {
+    @ApiProperty({example: "[email protected]"})
     @IsNotEmpty()
     identity: string;
-
+    
+    @ApiProperty({example: "secret"})
     @IsNotEmpty()
     password: string;
-
+    
+    @ApiProperty()
     device: DeviceDTO;
-
+    
+    @ApiProperty()
     coordinate: CoordinateDTO;
 }
 

src/entities/app-config.entity.ts

@@ -1,7 +1,7 @@
 import { Column, Entity, PrimaryGeneratedColumn } from "typeorm";
 
 @Entity({
-    name: "setting_apps"
+    name: "app_configs"
 })
 export class AppConfig {
 

src/main.ts

@@ -27,6 +27,12 @@ async function bootstrap() {
     .setTitle('StarterKit Project')
     .setDescription('This is nestjs starter kit, it\'s will help you when creating new project with nestjs.')
     .setVersion('1.0')
+    .addSecurity('api-key', {
+      type: 'apiKey',
+      in: 'header',
+      name: 'x-api-key'
+    })
+    .addBearerAuth()
     .addTag('Auth', "All about authentication")
     .build();
   const document = SwaggerModule.createDocument(app, config);