Nest.js

Swagger를 이용한 API 문서화

Swagger 문서는 엔드포인트 목록을 드러내는 화면을 넘어 요청/응답 DTO, 상태 코드, 인증 요구 조건을 OpenAPI 계약으로 고정하는 산출물입니다.

엔드포인트 계약, 요청/응답 스키마, 인증 정보를 기준으로 Swagger 문서를 구성합니다.

Swagger를 이용한 API 문서화 흐름

1

Swagger(OpenAPI)란 개념

Swagger는 OpenAPI 명세를 생성하고 UI 문서로 노출하는 오픈소스 도구 생태계를 말합니다.

2

NestJS에 Swagger 통합하기

NestJS는 @nestjs/swagger 패키지의 데코레이터와 SwaggerModule로 컨트롤러 메타데이터를 OpenAPI 문서로 변환합니다.

3

Swagger UI 확인

문서 엔드포인트를 열어 컨트롤러, DTO 스키마, 인증 헤더가 OpenAPI 문서에 반영됐는지 확인합니다.

4

API 문서화

OpenAPI는 REST API를 기계가 읽는 문서로 설명하는 표준입니다.