
[개발환경구축] Swagger로 API 문서 만들기 (Express + TypeScript)
·
개발환경구축
swagger-jsdoc와 swagger-ui-express를 활용한 API 명세 자동화API를 개발하다 보면 문서화가 중요한 만큼, 이를 자동으로 해주는 도구가 필요합니다. 그중에서도 Swagger는 널리 쓰이는 도구입니다. 이번 포스팅에서는 Express + TypeScript 프로젝트에 Swagger를 적용해 자동 API 문서를 만드는 과정을 단계별로 소개합니다.1. Swagger 패키지 설치Swagger를 Express에 연동하기 위해 아래 두 가지 패키지를 설치합니다.npm install swagger-jsdoc swagger-ui-expressswagger-jsdoc: 주석 기반으로 Swagger 문서 스펙(JSON)을 생성swagger-ui-express: 생성된 문서를 시각화하는 UI 서버..