[NestJS] Swagger 적용하기 (feat. API 문서화)
Nest에서 스웨거를 사용하는 방법을 설명합니다. API 문서화 API 문서화란 API 사용 방법을 문서로 정리하는 것을 말합니다. 보통 엔드포인트와 HTTP 메서드, 요청 및 응답 형식, 인증 방법, 예시 등이 내용으로 들어갑니다. API 문서는 워드나 노션 이용해 개발자가 직접 수기로 작성할 수도 있고, 스웨거와 같은 도구를 이용할 수도 있습니다. 쉽게 말해 `'API 요청 주소는 여기고요. 요청 파라미터는 이런 것들이 있습니다. 이렇게 호출하면 이런 결과가 나와요~! ✋'` 와 같이 API 사용 설명서를 만드는 일이라고 할 수 있습니다. 공공데이터포털에서 예시를 쉽게 찾아볼 수 있습니다. 왜 필요한가요? API 사용자의 편의를 위해서 입니다! 사용자는 보통 프론트엔드 개발자나, 해당 API를 이용해..
TS | NestJS
2024. 3. 15. 17:06