키보드로 물고기 잡기 키보드로 물고기 잡기

안녕하세요. 이 글은 제가 서버 개발자로 일하며 회사내 동료, 외부 업체 등에 Open API 형태로 API 문서를 제공했던 경험들을 공유 합니다. 1. Swgger가 있잖아요 ? 먼저 Swagger 이야기를 해볼게요. Swagger를 사용했을때 단점은 다음과 같았습니다. 비즈니스 코드 곳곳에 어노테이션을 추가해야 합니다. 이러다 보니 문서를 위한 어노테이션 및 주석을 달아야 하고 해당 어노테이션이 추가될때마다 관리도 되지 않고 문서를 위한 작업을 해야했습니다. 보는 사람에 따라 코드 가독성이 떨어지기도 합니다. 저의 경우 그랬습니다. 하지만 가장 좋지 않다고 생각했던것은, 예전에 API의 A값의 의미는 "a" 였는데 개발을 진행하다보니 혹은 릴리즈를 하다보니 "b"로 바뀌는 경우 해당 어노테이션을 수정..