🚀 Building Toy: REST API در NestJS

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
nvm install 20.9.0
nvm use 20.9.0

   npm i -g @nestjs/cli
   nest new todo-app
   cd todo-app

   nest generate module todos
   nest generate service todos
   nest generate controller todos

export class Todo {
  id: string;
  title: string;
  description?: string;
  isCompleted: boolean;
}

export class CreateTodoDto {
  title: string;
  description?: string;
}

import { Injectable } from '@nestjs/common';
import { Todo } from './todo.model';
import { CreateTodoDto } from './create-todo.dto';
import { v4 as uuidv4 } from 'uuid';

@Injectable()
export class TodosService {
  private todos: Todo[] = [];

  findAll(): Todo[] {
    return this.todos;
  }

  findOne(id: string): Todo {
    return this.todos.find(todo => todo.id === id);
  }

  create(createTodoDto: CreateTodoDto): Todo {
    const todo: Todo = {
      id: uuidv4(),
      isCompleted: false,
      ...createTodoDto
    };
    this.todos.push(todo);
    return todo;
  }

  update(id: string, updateTodoDto: CreateTodoDto): Todo {
    const todo = this.findOne(id);
    if (!todo) {
      return null;
    }
    this.todos = this.todos.map(t => t.id === id ? { ...t, ...updateTodoDto } : t);
    return this.findOne(id);
  }

  delete(id: string): boolean {
    this.todos = this.todos.filter(todo => todo.id !== id);
    return this.todos.length < initiallyLength;
  }
}

import { Controller, Get, Post, Put, Delete, Body, Param } from '@nestjs/common';
import { TodosService } from './todos.service';
import { Todo } from './todo.model';
import { CreateTodoDto } from './create-todo.dto';

@Controller('todos')
export class TodosController {
  constructor(private readonly todosService: TodosService) {}

  @Get()
  findAll(): Todo[] {
    return this.todosService.findAll();
  }

  @Post()
  create(@Body() createTodoDto: CreateTodoDto): Todo {
    return this.todosService.create(createTodoDto);
  }
}

   npm install @nestjs/swagger swagger-ui-express

   import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';
   import { AppModule } from './app.module';
   import { NestFactory } from '@nestjs/core';

   async function bootstrap() {
     const app = await NestFactory.create(AppModule);
     const config = new DocumentBuilder()
       .setTitle('To-Do API')
       .setDescription('The To-Do API description')
       .setVersion('1.0')
       .build();
     const document = SwaggerModule.createDocument(app, config);
     SwaggerModule.setup('api', app, document);

     await app.listen(3000);
   }
   bootstrap();

npm run start:dev

import { ApiProperty } from '@nestjs/swagger';

export class Todo {
  @ApiProperty({ example: '1', description: 'Unique identifier of the todo' })
  id: string;

  @ApiProperty({ example: 'Buy groceries', description: 'Title of the todo' })
  title: string;

  @ApiProperty({ example: 'Remember to buy milk and eggs', description: 'Detailed description of the todo', required: false })
  description?: string;

  @ApiProperty({ example: false, description: 'Completion status of the todo' })
  isCompleted: boolean;
}

import { ApiProperty } from '@nestjs/swagger';

export class CreateTodoDto {
  @ApiProperty({ example: 'Buy groceries', description: 'Title of the todo' })
  title: string;

  @ApiProperty({ example: 'Remember to buy milk and eggs', description: 'Detailed description of the todo', required: false })
  description?: string;
}

import { Controller, Get, Post, Put, Delete, Body, Param } from '@nestjs/common';
import { TodosService } from './todos.service';
import { Todo } from './todo.model';
import { CreateTodoDto } from './create-todo.dto';
import { ApiTags, ApiOperation, ApiResponse } from '@nestjs/swagger';

@ApiTags('todos')
@Controller('todos')
export class TodosController {
  constructor(private readonly todosService: TodosService) {}

  @Get()
  @ApiOperation({ summary: 'Retrieve all todos' })
  @ApiResponse({ status: 200, description: 'List of todo items', type: [Todo] })
  findAll(): Todo[] {
    return this.todosService.findAll();
  }

  @Post()
  @ApiOperation({ summary: 'Create a new todo' })
  @ApiResponse({ status: 201, description: 'The created todo', type: Todo })
  create(@Body() createTodoDto: CreateTodoDto): Todo {
    return this.todosService.create(createTodoDto);
  }

  // Continue with other methods using similar Swagger annotations
}

npm run start:dev