NestJS에서 Swagger CLI Plugins 사용하여 API 문서화하기

 

NestJS는 강력한 모듈 시스템과 데코레이터 기반의 코드를 통해 손쉽게 API를 작성할 수 있도록 도와줍니다. 이번 포스트에서는 NestJS에서 Swagger CLI 플러그인을 사용하여 API 문서를 생성하는 방법에 대해 알아보겠습니다.

 

1. nest-cli.json 파일 설정

{
  "collection": "@nestjs/schematics",
  "sourceRoot": "src",
  "compilerOptions": {
    "plugins": [
      {
        "name": "@nestjs/swagger/plugin",
        "options": {
          "classValidatorShim": true,
          "introspectComments": true
        }
      }
    ]
  }
}

 

 

 

2. SomeController 클래스 작성

export class SomeController {
  /**
   * Create some resource
   */
  @Post()
  create() {}
}

 

 

Swagger CLI Plugin을 적용하다 entity에 @example를 적용하려 했으나 정상적으로 동작하지 않았던 경우가 있었습니다. 엔티티에 파일이름이 User.ts로만 되어있어 entity로 되어있지 않아 Swagger에서 적용을 안한거같습니다. User.ts파일 이름을 User.entity.ts로 수정해주니 정상적으로 동작을 하였습니다.