NestJS+TypeORM으로 백엔드 구축 PART1 【설치, RESTAPI 구현】

16710 단어 NestJS TypeORM TypeScript

대체로 공식 문서대로 구현해 갑니다.

-1- 준비편

1.nestjs를 설치하여 프로젝트를 만듭니다.

nestjs 설치 및 프로젝트 작성

 npm i -g @nestjs/cli 
 nest new project-name

2. 프로젝트를 열고 필요한 패키지를 설치합니다.

프로젝트에 필요한 npm 패키지 설치

  npm i --save @nestjs/core @nestjs/common rxjs reflect-metadata
  npm i --save @nestjs/typeorm typeorm mysql2

3. 프로젝트의 루트 디렉토리에 ormconfig.json 만들기

나중에 ER 다이어그램을 자동으로 만들고 싶으므로 ormconfig.json을 사용하여 DB 정보를 전달합니다.

ormconfig.json

{
  "type": "mysql",
  "host": "localhost",
  "port": 3305,
  "username": "root",
  "password": "root",
  "database": "test",
  "entities": ["dist/**/*.entity{.ts,.js}"],
  "synchronize": true
}

4. mysql 컨테이너를 3305번 포트에서 시작

3305번 포트에서 mysql 컨테이너를 기동

docker run -it \
-e MYSQL_DATABASE=test \
-e MYSQL_ROOT_PASSWORD=root \
-p 3305:3306 \
-d mysql

-2- 구축편

-1- app.module.ts 편집

app.module.ts

import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import {TypeOrmModule} from "@nestjs/typeorm";
@Module({
  imports: [TypeOrmModule.forRoot()],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}

-2- UsersModule을 CLI로 작성

nest g module users
nest g service users
nest g controller users

users라는 디렉토리가 CLI에 의해 src에 작성됩니다.
그런 다음 라우팅을 위해 컨트롤러와 컨트롤러에서 호출되어 처리하는 서비스도 만들어 둡니다.

-3- user.entity.ts 작성 및 편집

users 디렉토리에 user.entity.ts를 만듭니다. 여기는 CLI에서 만들 수 없으므로 수동으로 만들 수 있습니다.

user.entity.ts

import { Entity, Column, PrimaryGeneratedColumn } from 'typeorm';
@Entity()
export class User {
  @PrimaryGeneratedColumn()
  id: number;
  @Column()
  firstName: string;
  @Column()
  lastName: string;
  @Column({ default: true })
  isActive: boolean;
}

-4- users.module.ts 편집

CLI가 자동으로 공급자와 컨트롤러를 추가하므로 편집이 필요한 것은 TypeORM 관계뿐입니다.

users.module.ts

import { Module } from '@nestjs/common';
import { TypeOrmModule } from '@nestjs/typeorm';
import { UsersService } from './users.service';
import { UsersController } from './users.controller';
import { User } from './user.entity';
@Module({
  imports: [TypeOrmModule.forFeature([User])],
  providers: [UsersService],
  controllers: [UsersController],
})
export class UsersModule {}

-5- users.service.ts 편집

users.service.ts

import { Injectable } from '@nestjs/common';
import { InjectRepository } from '@nestjs/typeorm';
import { Repository } from 'typeorm';
import { User } from './user.entity';
@Injectable()
export class UsersService {
  constructor(
    @InjectRepository(User)
    private usersRepository: Repository<User>,
  ) {}
  findAll(): Promise<User[]> {
    return this.usersRepository.find();
  }
  findOne(id: string): Promise<User> {
    return this.usersRepository.findOne(id);
  }
  async remove(id: string): Promise<void> {
    await this.usersRepository.delete(id);
  }
}

-6- users.controller.ts 편집

users.service.ts

import { Injectable } from '@nestjs/common';
import { InjectRepository } from '@nestjs/typeorm';
import { Repository } from 'typeorm';
import { User } from './user.entity';
@Injectable()
export class UsersService {
  constructor(
    @InjectRepository(User)
    private usersRepository: Repository<User>,
  ) {}
  findAll(): Promise<User[]> {
    return this.usersRepository.find();
  }
  findOne(id: string): Promise<User> {
    return this.usersRepository.findOne(id);
  }
  async remove(id: string): Promise<void> {
    await this.usersRepository.delete(id);
  }
}