[Feature] swagger for API documentation

[Tolerblanc]

요약

• swagger 설치 후 API 스펙 명시 & 프론트 협업을 위한 문서화

내용

• [ ] swagger 및 관련 모듈 설치
• [ ] 기본 swagger 페이지 설정
• [ ] 데코레이터를 통해 API별 명세 작성

참고자료

• 공식문서
• 블로그
  

[Tolerblanc]

swagger 예제 공식문서 - 데코레이터 종류

문서 찾아 보고 몇차례 테스트 해 본 결과, 아주 잘 동작하지만 제대로 작성하려면 데코레이터 떡칠이 될 것 같습니다. swagger 페이지에서 API 테스트가 가능하기도 하고, 정말 상세히 적을 수 있어서 좋긴 한데, 사용 여부는 회의를 해봐야 할 것 같습니다.

[Tolerblanc]

feature/swagger 브랜치에서 서버 켠 후 https://localhost:3000/api로 접속하면 확인 가능합니다.

[ebang091]

오호.. 얼마나 많길ㄹ래~~

[Tolerblanc]

되게 직관적으로 작성할 수 있게 되어있긴 한데, 데코레이터 특성상 위로 주렁주렁 메달아놔야 하다 보니 코드가 깔끔해보이진 않네요 ㅠ