# API 문서화 및 계약 (Node.js / NestJS)

> Swagger, OpenAPI, 버전 관리, 버전별 문서화, Postman, 컬렉션, API 계약

- 20 면접 질문
- Junior
- [면접 질문: Node.js / NestJS](https://sharpskill.dev/ko/technologies/node-nestjs/interview-questions.md)

## 1. NestJS 맥락에서 Swagger란 무엇인가요?

**답변**

Swagger는 NestJS 데코레이터를 분석하여 대화형 REST API 문서를 자동으로 생성하는 도구입니다. 이 문서를 통해 /api로 접근할 수 있는 웹 인터페이스에서 엔드포인트를 직접 시각화하고 테스트할 수 있습니다. 사용하려면 @nestjs/swagger 패키지를 설치하고 main.ts에서 SwaggerModule을 설정해야 합니다.

## 2. NestJS에서 Swagger를 사용하려면 어떤 패키지를 설치해야 하나요?

**답변**

@nestjs/swagger 패키지는 Swagger를 NestJS 애플리케이션에 통합하기 위한 공식 라이브러리입니다. 또한 대화형 웹 인터페이스를 제공하는 swagger-ui-express도 설치해야 합니다. 이 두 패키지는 함께 작동하여 OpenAPI 문서를 생성하고 브라우저에 표시합니다.

## 3. NestJS 애플리케이션에서 SwaggerModule을 어디에 설정하나요?

**답변**

SwaggerModule은 NestFactory.create()로 NestJS 애플리케이션을 생성한 후 main.ts 파일에서 설정합니다. SwaggerModule.setup() 메서드는 문서 경로, 애플리케이션 인스턴스, createDocument()로 생성된 문서라는 세 가지 매개변수를 받습니다. 이 설정은 시작 시 문서에 접근할 수 있도록 app.listen() 전에 수행해야 합니다.

## 17개 추가 질문 이용 가능

- @ApiTags() 데코레이터의 역할은 무엇인가요?
- OpenAPI란 무엇인가요?

무료로 가입하기: https://sharpskill.dev/ko/login

## 기타 Node.js / NestJS 면접 주제

- [Node.js 기초](https://sharpskill.dev/ko/technologies/node-nestjs/interview-questions/nodejs-fundamentals.md): 20개 질문, Junior
- [Node.js 코어 API](https://sharpskill.dev/ko/technologies/node-nestjs/interview-questions/nodejs-core-apis.md): 25개 질문, Junior
- [비동기 프로그래밍](https://sharpskill.dev/ko/technologies/node-nestjs/interview-questions/asynchronous-programming.md): 25개 질문, Junior
- [Express.js 기초](https://sharpskill.dev/ko/technologies/node-nestjs/interview-questions/express-basics.md): 20개 질문, Junior
- [NestJS 기초](https://sharpskill.dev/ko/technologies/node-nestjs/interview-questions/nestjs-fundamentals.md): 23개 질문, Junior
- [REST API 설계](https://sharpskill.dev/ko/technologies/node-nestjs/interview-questions/rest-api-design.md): 20개 질문, Junior
- [검증과 DTO](https://sharpskill.dev/ko/technologies/node-nestjs/interview-questions/validation-dto.md): 20개 질문, Junior
- [에러 처리](https://sharpskill.dev/ko/technologies/node-nestjs/interview-questions/error-handling.md): 20개 질문, Junior
- [단위 테스트](https://sharpskill.dev/ko/technologies/node-nestjs/interview-questions/testing-unit.md): 20개 질문, Junior
- [작업 스케줄링](https://sharpskill.dev/ko/technologies/node-nestjs/interview-questions/scheduling-cron.md): 15개 질문, Junior
- [NestJS 모듈과 DI](https://sharpskill.dev/ko/technologies/node-nestjs/interview-questions/nestjs-modules-di.md): 20개 질문, Mid-Level
- [구성 및 환경 관리](https://sharpskill.dev/ko/technologies/node-nestjs/interview-questions/configuration-environment.md): 20개 질문, Mid-Level
- [JWT 인증](https://sharpskill.dev/ko/technologies/node-nestjs/interview-questions/authentication-jwt.md): 25개 질문, Mid-Level
- [인가 및 RBAC](https://sharpskill.dev/ko/technologies/node-nestjs/interview-questions/authorization-rbac.md): 20개 질문, Mid-Level
- [TypeORM을 사용한 데이터베이스](https://sharpskill.dev/ko/technologies/node-nestjs/interview-questions/database-typeorm.md): 30개 질문, Mid-Level
- [Prisma ORM](https://sharpskill.dev/ko/technologies/node-nestjs/interview-questions/prisma-orm.md): 25개 질문, Mid-Level
- [미들웨어와 인터셉터](https://sharpskill.dev/ko/technologies/node-nestjs/interview-questions/middleware-interceptors.md): 20개 질문, Mid-Level
- [파일 업로드](https://sharpskill.dev/ko/technologies/node-nestjs/interview-questions/file-upload.md): 15개 질문, Mid-Level
- [WebSockets](https://sharpskill.dev/ko/technologies/node-nestjs/interview-questions/websockets.md): 20개 질문, Mid-Level
- [NestJS를 사용한 GraphQL](https://sharpskill.dev/ko/technologies/node-nestjs/interview-questions/graphql-basics.md): 25개 질문, Mid-Level
- [엔드투엔드 테스트](https://sharpskill.dev/ko/technologies/node-nestjs/interview-questions/testing-e2e.md): 20개 질문, Mid-Level
- [Redis를 사용한 캐싱](https://sharpskill.dev/ko/technologies/node-nestjs/interview-questions/caching-redis.md): 20개 질문, Mid-Level
- [Bull을 사용한 큐](https://sharpskill.dev/ko/technologies/node-nestjs/interview-questions/queues-bull.md): 20개 질문, Mid-Level
- [DevOps, Logging, CI/CD](https://sharpskill.dev/ko/technologies/node-nestjs/interview-questions/logging-monitoring.md): 25개 질문, Mid-Level
- [Docker 및 컨테이너화](https://sharpskill.dev/ko/technologies/node-nestjs/interview-questions/docker-containerization.md): 25개 질문, Mid-Level
- [마이크로서비스](https://sharpskill.dev/ko/technologies/node-nestjs/interview-questions/microservices.md): 30개 질문, Senior
- [보안 모범 사례](https://sharpskill.dev/ko/technologies/node-nestjs/interview-questions/security-best-practices.md): 25개 질문, Senior
- [성능 및 클라우드 배포](https://sharpskill.dev/ko/technologies/node-nestjs/interview-questions/performance-optimization.md): 30개 질문, Senior

---

Source: SharpSkill (https://sharpskill.dev), tech interview preparation for your real stack.
HTML version of this page: https://sharpskill.dev/ko/technologies/node-nestjs/interview-questions/api-documentation