Nest.js

Swagger를 이용한 API 문서화

지난 절에서는 DTO와 유효성 검사를 통해 API 견고함을 높이는 방법을 알아봤습니다. 이번 절에서는 RESTful API 활용도를 높이고 협업 효율을 개선하는 데 필수적인 API 문서화를 다룹니다.

API 문서화와 Swagger(OpenAPI)를 중심으로 Swagger를 이용한 API 문서화의 판단 흐름을 읽습니다.

핵심 흐름

1

Swagger(OpenAPI)란 무엇인가?

Swagger는 API를 설계, 빌드, 문서화, 사용하는 데 도움이 되는 오픈소스 도구들의 생태계를 말합니다.

2

NestJS에 Swagger 통합하기

NestJS는 @nestjs/swagger 패키지를 통해 Swagger를 손쉽게 통합할 수 있도록 지원합니다.

3

Swagger UI 확인

애플리케이션을 실행합니다.

4

API 문서화

현재는 OpenAPI Specification(OAS)이라는 이름으로 표준화되어 있으며, 이는 RESTful API를 언어 독립적으로 설명하기 위한 기계 판독...