[Feat] swagger 세팅

[begong313]

관련 이슈 번호

close #77

작업 내용

• swagger 설치

pnpm add @nestjs/swagger swagger-ui-express

• swagger 세팅

  const config = new DocumentBuilder()
    .setTitle('Ticle API server') 
    .setDescription('API 서버의 api 문서입니다.')
    .setVersion('1.0')
    .build();
  const document = SwaggerModule.createDocument(app, config);
  SwaggerModule.setup('api-doc', app, document); //"URL/api-doc" 으로 swagger 접속가능

• swagger 테스트

@Get()
  @ApiOperation({ summary: 'swaggerTest' })
  @ApiResponse({ status: 200, description: '기본 존재하는 api Test.' })
  getHello(): string {
    return this.appService.getHello();
  }

PR 포인트

• 설치 서버쪽에만 잘 됐는지 확인해주시면 될거같습니다....

고민과 학습내용

• 설치를 제대로 한건가...?
  • pnpm을 첫 사용하고 tuborepo monorepo 를 처음 사용했기 때문에 설치를 제대로 한것인지 잘 모르겠음
  • api 서버로 들어가 위의 설치명령어를 통해 swagger 설치하였음.

스크린샷

Todo

• 추후 배포 시 swagger 접속안되게 환경변수 세팅하면서 환경변수에 따라 swagger 접속 안되게 고치기

[simeunseo]

배워갑니다. 🐒

[seoko97]

👍👍👍