Swagger를 이용한 Spring Boot API 명세작업(1)

배경

---

비전공자로서 이전에 명세작업이 왜 중요한가 궁금했었을 때, 직접  작성하고 프로젝트를 하니 정말 차이가 크다고 느꼈다는 것을 이야기 했었습니다.

왜 개발자분들이 프로젝트 시작 전 세팅에 시간이 가장 많이 걸릴까를 조금이나마 이해한 부분이었죠. 기초를 잘 닦아놓으면 그 뒤는 자연스럽게 이어지거든요.

 

하지만 길잡이를 꼭 API 문서만 놓고 갈 필요는 없을 것 같습니다. 물론 아주 큰 대형 프로젝트라면 명세서만 따라야겠지만, 소규모의 프로젝트에서는 API로 큰 틀을 바로 잡아놓고 직접 코드를 만들어가면서 수정해야 할 부분이 많겠죠.

 

내용

---

API가 작업 중간중간 변하게 되면 명세서를 계속해서 작업해야 하는 일이 발생하게 될겁니다.

저는 백엔드 개발자로서 나중에 회사에 들어가면 프론트엔드 분들과 함께 일하게 될텐데 API 명세서를 잘 작성하는게 서로의 신뢰와 믿음의 증거가 될거라 생각합니다.

이에 현재 개발자들 사이에서 주로 쓰이는 swagger와 Spring Rest docs 사이에 뭘 쓸까 고민하다가 swagger를 이번 프로젝트에 적용시켜볼까 합니다.

선정 이유는 다음과 같습니다.

1. Spring Rest docs에 비해 쉽다.

- 이 이유는 제 개발 실력과 프로젝트 남은 기간을 생각했을 때 rest docs를 제대로 적용도 못하고 끝낼 것 같아 swagger를 선택한 이유가 되었습니다.

2. Spring Rest docs에 비해 알아보기 편하다.

- 제가 프론트 엔드 개발자는 아니지만, swagger를 보면 한눈에 어떤 API들이 있고, 각 요청과 응답을 어떤 식으로 주고 받는지 알아보기 쉽게 되어있기 때문입니다.

 

물론 swagger를 통하면 코드가 좀 난잡해지는 부분이 있긴 하지만, 이번 프로젝트에서는 swagger 선택하려고 합니다.

 

다음 글에는 Swagger를 통해 코드에 직접 접목한 과정과 결과들을 작성해 보겠습니다.

 

좋은 하루들 되세요!