Nestjs tutorial
1. 프로젝트 생성하기
nestjs cli 를 이용하면 쉽게 프로젝트를 생성 할수 있습니다.
# nestjs cli 설치
$ npm i -g @nestjs/cli
# 프로젝트 생성
$ nest new project-name
다음 라이브러리를 설치합니다.
$ npm install --save @nestjs/swagger swagger-ui-express
이후 main.ts에 SwaggerModule 설정을 합니다
# main.ts
import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
import { NestExpressApplication } from "@nestjs/platform-express";
import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';
async function bootstrap() {
const app = await NestFactory.create<NestExpressApplication>(AppModule);
const options = new DocumentBuilder()
.setTitle('프로젝트 명')
.setDescription('프로젝트 설명')
.setVersion('1.0')
.build();
const document = SwaggerModule.createDocument(app, options);
SwaggerModule.setup('docs', app, document);
await app.listen(process.env.PORT);
}
bootstrap();
request 요청에 대한 Validation(검증) 처리를 위해
다음 라이브러리의 설치가 필요 합니다.
$ npm install class-validator
Global 설정을 main.ts에 추가 합니다.
Transform payload objects 설정을 하여 자동 변환 처리를 합니다.
# main.ts
import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
import { NestExpressApplication } from "@nestjs/platform-express";
import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';
import { ValidationPipe } from '@nestjs/common';
async function bootstrap() {
const app = await NestFactory.create<NestExpressApplication>(AppModule);
app.useGlobalPipes(new ValidationPipe({transform: true})); // Validate with 자동 변환 처리
const options = new DocumentBuilder()
.setTitle('프로젝트 명')
.setDescription('프로젝트 설명')
.setVersion('1.0')
.build();
const document = SwaggerModule.createDocument(app, options);
SwaggerModule.setup('docs', app, document);
await app.listen(process.env.PORT);
}
bootstrap();
이후 예제는 auto-validation에서 확인하세요.
express에서는 dotenv를 사용하였는데, nestjs에서는 Configuration이 제공 됩니다.
설치는 아래와 같습니다.
$ npm i --save @nestjs/config
사용법은 app.module.ts에 선언을 하여서 사용합니다. isGlobal 설정을 해두면 다른 모듈에서 imports 하지 않고 사용이 가능합니다.
기본적으로 .env 파일을 읽어서 변수화 하여 사용합니다.
import { Module } from '@nestjs/common';
import { ConfigModule } from '@nestjs/config';
@Module({
imports: [ConfigModule.forRoot({ isGlobal: true })],
})
export class AppModule {}
더 자세한 예제는 Using the ConfigService를 참조하세요.
nestjs에서는 기본적으로 Logger class를 제공합니다.
main.js에서 ApplicationModule에서 logger 옵션을 이용해서 레벨을 설정할 수 있습니다.
레벨은 'log', 'error', 'warn', 'debug', 'verbose' 이 있습니다.
const app = await NestFactory.create(ApplicationModule, {
logger: ['error', 'warn'],
});
await app.listen(3000);
사용법은 Using the logger for application logging 같이 주입하여 사용이 가능합니다.
import { Logger, Injectable } from '@nestjs/common';
@Injectable()
class MyService {
private readonly logger = new Logger(MyService.name);
doSomething() {
this.logger.log('Doing something...');
}
}
세션은 express를 사용할 경우 express-session 모듈을 설치해서 사용합니다.
$ npm i express-session
사용법은 main.ts에 아래 코드를 추가합니다.(이는 express-session 사용법을 자세히 보세요.)
import * as session from 'express-session';
// somewhere in your initialization file
app.use(
session({
secret: 'my-secret',
resave: false,
saveUninitialized: false,
}),
);
helmet 과 cors 설정은 다른 설정 함수 보다 먼저 설정되어야 합니다.
만약 경로를 정의한 후 helmet과 cors를 설정할 경우 이미 설정된 경로의 미들웨어는 적용되지 않을 수 있습니다.
helmet은 http 해더를 적정하게 설정하여 웹 취약점으로 부터 앱을 보호 합니다.
설치
$ npm i --save helmet
사용법
import * as helmet from 'helmet';
// somewhere in your initialization file
app.use(helmet());
cors는 다른 도메인에서 리소스를 요청 할 수 있도록하는 설정입니다.
설치는 따로 필요 없습니다. 사용법은 아래와 같습니다.
const app = await NestFactory.create(AppModule);
app.enableCors();
await app.listen(3000);
main.ts 예제
다음은 제가 사용한 예제 입니다.
import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
import { NestExpressApplication } from "@nestjs/platform-express";
import * as helmet from 'helmet';
import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';
import { ValidationPipe } from '@nestjs/common';
import * as session from 'express-session';
import * as passport from 'passport';
import flash = require('connect-flash');
async function bootstrap() {
const app = await NestFactory.create<NestExpressApplication>(AppModule);
app.setGlobalPrefix('api'); // prefix 설정
app.useGlobalPipes(new ValidationPipe({ transform: true })); // validate 사용 설정
app.use(helmet({
contentSecurityPolicy: false,
})); // helmet 설정과 CSP 제외 (google analytics 사용시 제외 해야함)
app.enableCors({
origin: [
/^(.*)/,
],
methods: 'GET,HEAD,PUT,PATCH,POST,DELETE,OPTIONS',
preflightContinue: false,
credentials: true,
optionsSuccessStatus: 204,
allowedHeaders:
'Origin,X-Requested-With,Content-Type,Accept,Authorization,authorization,X-Forwarded-for',
}); // cors 설정 credentials 설정을 해야 credentials 정보도 함께 전달함
const options = new DocumentBuilder()
.setTitle('프로젝트 명')
.setDescription('프로젝트 설명')
.setVersion('1.0')
.addBearerAuth() // openapi 문서에서 권한 처리 추가
.build();
const document = SwaggerModule.createDocument(app, options);
SwaggerModule.setup('docs', app, document); // openapi 사용
app.use(session({
secret: process.env.SECCRET || 'keyboard cat',
resave: false,
saveUninitialized: false,
})); // session 사용
// passport 설정
app.use(passport.initialize());
app.use(passport.session());
// request에 값을 추가 하는 flash 추가
app.use(flash());
await app.listen(process.env.PORT);
}
bootstrap();
상세한 예제는 다음 2개의 프로젝트를 참고 하세요.
- nestjs-realworld-example-app
- test-auth-chapter-sample
참고자료
댓글을 달아 주세요