Merge pull request #1 from oreyon/main

Add nest/swagger API documentation

Author: hafizcode02

README.md

@@ -2,9 +2,6 @@
   <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="120" alt="Nest Logo" /></a>
 </p>
 
-[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
-[circleci-url]: https://circleci.com/gh/nestjs/nest
-
   <p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
     <p align="center">
 <a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
@@ -27,7 +24,9 @@
 My Learning Project in Nest.JS, Creating Simple Contact API
 
 ## Project Checklist
+
 ### User Endpoint
+
 - [x] Register User
 - [x] Send Email to Verify User
 - [x] Verify User
@@ -38,6 +37,7 @@ My Learning Project in Nest.JS, Creating Simple Contact API
 - [x] Logout User
 
 ### Contact Endpoint
+
 - [x] Get All Contact & Search Contact
 - [x] Create Contact
 - [x] Get Contact
@@ -46,26 +46,31 @@ My Learning Project in Nest.JS, Creating Simple Contact API
 - [x] Delete Contact
 
 ### Address Endpoint
+
 - [x] Get All Addresses in the Contact
 - [x] Create Addresses of Contact
 - [x] Get Address
 - [x] Update Address
 - [x] Delete Address
 
-
 ### Todo
+
 - [ ] Make Endpoint for forgot password
-- [ ] Setup Swagger UI
-- [ ] Create setup for multer to upload in cloud bucket like Cloudflare R2, AWS S3, or GCP Cloud Storage 
+- [x] Setup Swagger UI
+- [ ] Create setup for multer to upload in cloud bucket like Cloudflare R2, AWS S3, or GCP Cloud Storage
 
 ## Project Endpoint
+
 You can see at **doc** folder or import the postman collection.
+or you can go to swagger api docs:
+
+[SWAGGER API DOCS](https://localhost:3000/api)
 
 ## Project setup
 
 ```bash
-$ npm install
-$ npx prisma init
+npm install
+npx prisma init
 ```
 
 ## Setup your .env
@@ -87,7 +92,7 @@ HASHIDS_SALT=YOURSALT
 ## Run Prisma
 
 ```bash
-$ npx prisma migrate dev
+npx prisma migrate dev
 ```
 
 ## Compile and run the project
@@ -111,7 +116,9 @@ $ npm run test
 ```
 
 ## Another way to Run
+
 More simple shortcut to use in windows :D
+
 ```bash
 run.bat dev|test|build|lint|prod
 ```
@@ -123,8 +130,8 @@ When you're ready to deploy your NestJS application to production, there are som
 If you are looking for a cloud-based platform to deploy your NestJS application, check out [Mau](https://mau.nestjs.com), our official platform for deploying NestJS applications on AWS. Mau makes deployment straightforward and fast, requiring just a few simple steps:
 
 ```bash
-$ npm install -g mau
-$ mau deploy
+npm install -g mau
+mau deploy
 ```
 
 With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure.

package-lock.json

@@ -23,6 +23,7 @@
     "@nestjs/config": "^3.3.0",
     "@nestjs/core": "^10.0.0",
     "@nestjs/platform-express": "^10.0.0",
+    "@nestjs/swagger": "^8.0.7",
     "@nestjs/throttler": "^6.2.1",
     "@prisma/client": "^5.22.0",
     "bcrypt": "^5.1.1",

package.json

@@ -4,9 +4,13 @@ import { UserModule } from './user/user.module';
 import { ThrottlerGuard, ThrottlerModule } from '@nestjs/throttler';
 import { ContactModule } from './contact/contact.module';
 import { AddressModule } from './address/address.module';
+import { ConfigModule } from '@nestjs/config';
 
 @Module({
   imports: [
+    ConfigModule.forRoot({
+      isGlobal: true,
+    }),
     ThrottlerModule.forRoot({
       throttlers: [
         {

src/app.module.ts

@@ -1,5 +1,4 @@
 import { Global, MiddlewareConsumer, Module, NestModule } from '@nestjs/common';
-import { ConfigModule } from '@nestjs/config';
 import { WinstonModule } from 'nest-winston';
 import * as winston from 'winston';
 import { PrismaService } from './prisma.service';
@@ -28,9 +27,6 @@ import { MulterService } from './multer.service';
         }),
       ],
     }),
-    ConfigModule.forRoot({
-      isGlobal: true,
-    }),
   ],
   controllers: [],
   providers: [

src/common/common.module.ts

@@ -14,11 +14,12 @@ export class MailService {
     this.transporter = nodemailer.createTransport({
       host: this.configService.get<string>('MAIL_HOST'),
       port: this.configService.get<number>('MAIL_PORT'),
-      secure: this.configService.get<boolean>('MAIL_SECURE'),
       auth: {
         user: this.configService.get<string>('MAIL_USER'),
         pass: this.configService.get<string>('MAIL_PASS'),
       },
+      debug: false,
+      logger: false,
     } as SMTPTransport.Options);
   }
 

src/common/mail.service.ts

@@ -30,7 +30,9 @@ import { User } from '@prisma/client';
 import { MulterService } from '../common/multer.service';
 import { MulterInterceptor } from '../common/multer.interceptor';
 import { Request } from 'express';
+import { ApiBearerAuth } from '@nestjs/swagger';
 
+@ApiBearerAuth()
 @Controller('/api/contacts')
 export class ContactController {
   constructor(

src/contact/contact.controller.ts

@@ -3,6 +3,7 @@ import { AppModule } from './app.module';
 import { WINSTON_MODULE_NEST_PROVIDER } from 'nest-winston';
 import { NestExpressApplication } from '@nestjs/platform-express';
 import { join } from 'path';
+import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
 
 async function bootstrap() {
   const app = await NestFactory.create<NestExpressApplication>(AppModule);
@@ -11,6 +12,16 @@ async function bootstrap() {
     prefix: '/uploads',
   });
 
+  const config = new DocumentBuilder()
+    .setTitle('Contact App API')
+    .setDescription('Contact App API')
+    .setVersion('1.0')
+    .addTag('Contacts')
+    .addBearerAuth()
+    .build();
+  const documentFactory = () => SwaggerModule.createDocument(app, config);
+  SwaggerModule.setup('api', app, documentFactory);
+
   const logger = app.get(WINSTON_MODULE_NEST_PROVIDER);
   app.useLogger(logger);
 

src/main.ts

@@ -1,9 +1,34 @@
+import { ApiProperty } from '@nestjs/swagger';
+
 export class AddressRequest {
+  @ApiProperty({
+    example: 'Jl. Kenangan',
+  })
   street: string;
+
+  @ApiProperty({
+    example: 'Jakarta',
+  })
   city: string;
+
+  @ApiProperty({
+    example: 'DKI Jakarta',
+  })
   province: string;
+
+  @ApiProperty({
+    example: 'Indonesia',
+  })
   country: string;
+
+  @ApiProperty({
+    example: '12345',
+  })
   postalCode: string;
+
+  @ApiProperty({
+    example: 'Yang ada di depan rumah',
+  })
   detail?: string;
 }
 
@@ -18,10 +43,26 @@ export class AddressResponse {
 }
 
 export class AddressUpdateRequest {
+  @ApiProperty({
+    example: '1840 Democracy Point',
+  })
   street?: string;
+
+  @ApiProperty({
+    example: 'Colorado Springs',
+  })
   city?: string;
+
+  @ApiProperty({
+    example: 'Colorado',
+  })
   province?: string;
+
+  @ApiProperty({
+    example: 'United States',
+  })
   country?: string;
+
   postalCode?: string;
   detail?: string;
 }