기존에 진행하던 프로젝트와 다르게 졸업작품은 프론트앤드 개발자 1명, 백앤드 개발자 2명 총 3명의 협업을 해야한다.
본격적으로 프로젝트를 진행하기에 앞서서, 기본적으로 설정을 해야할 것들을 정하던 중, 프론트앤드 개발자 분이 swagger 나 restdocs 적용했으면 좋을 것 같다는 의견을 내주셨다.
사실 기존에 진행하던 프로젝트에서 스웨거를 적용해볼까? 라는 생각도 했었는데, 미루다보니 적용을 못했고, 솔직히 조금 귀찮았었다.
그래서 이번 졸업작품 프로젝트에서는 개발 초기 부터 Swagger 혹은 Restdocs 를 적용해보기로 하였다.
그래도 일단 이 기술들이 무엇인지 찾아보았고, 왜 적용해야하는지 다시 한번 고민해보면서 정리를 하였다.
간단하게 설명하자면 API 문서를 자동으로 만들어 주는 라이브러리다. 어노테이션을 통해 생성된 API를 문서내에서 parameter 조작을 통해서 바로 실행할 수 있다.