Swagger, Rest Docs 어떤 걸 선택을 할까?

Swagger / Spring REST Docs

선택 이유

• 현재 프로젝트는 프론트와 Jira로 협업을 하면서 기능을 추가하고 End Point에 대한 정보를 전달을 해야됩니다.
• 프로젝트 초기 단계가 지나 작성해야 하는 API들이 많아지면서 일일이 작성하고 확인하기가 번거로움
• 코드상으로 해결 가능한 Swagger를 적용하여 문서화를 진행했습니다.

문제점

• 프로젝트를 진행하면서 API가 많아지며 코드의 가독성이 매우 떨어지는 문제점이 발생을 하였습니다.
• 테스트 기반으로 작성한 부분이 아니기 때문에 100% 신뢰성을 가질 수 없다.
• 모든 오류에 대한 여러 가지 응답을 문서화 하기 어렵다.

결과

• 현재는 프로젝트를 진행하면서 End Point를 전달을 하는게 제일 중요한 포인트 - 스웨거 선택 이유
• 이후 프로젝트가 끝나면 Rest Docs로 변경하여 단점을 해결할 예정