개발연습/swagger
-
node.js ts 프로젝트에 swagger를 적용해보자!개발연습/swagger 2021. 9. 17. 12:23
프로젝트를 진행할 때 api문서는 필수적이다. 한명이 프론트-백을 전부 담당하면 모르겠지만, 일반적으로는 다른 인원이 다루기에 각 라우터에 대한 정확한 input/output 값을 알고 있어야 한다. 게다가 우리 프로젝트는 ts를 적용중으로 더욱 중요하다! 원래는 마크다운으로 관리를 하고 있었지만... 슬슬 귀찮아지는게 느껴져서 api문서 툴을 알아보게 되었다. api문서를 다루는 툴은 여러가지가 있지만 그중에서도 swagger에 대한 추천이 많아서 적용하게 되었다. 그런데.. swagger를 적용하는 방법도 여러가지가 있고 해서 열심히 영어읽느라 고생 좀 했다. 인터넷을 통해 알아본 방법으로 swagger를 적용하는 방법은 크게 두가지가 있다는 것을 알았다. 1. 각 ts파일에 주석형식으로 추가하는 방..