Swagger 도입으로 코드-문서 동기화 + 소통 기준이 된 경험으로 설명
팀 프로젝트에서 Swagger로 API 문서를 처음 자동 생성했습니다. 이전에는 Notion에 API 명세를 수동으로 작성했는데, 코드와 문서가 따로 놀아서 프런트엔드에서 잘못된 파라미터로 요청을 보내는 경우가 생겼습니다. @ApiProperty 데코레이터로 코드에 명세를 붙이니 배포 후 자동으로 문서가 갱신되는 구조가 됐습니다. 문서가 살아있으니 프런트엔드와 명세를 기준으로 소통하는 방식이 생겼고, 인터페이스 불일치 논쟁이 줄었습니다. Swagger UI에서 API를 직접 테스트할 수 있는 기능도 실제로 개발 속도를 높여줬습니다. 버전 변경이 생길 때마다 문서를 업데이트하는 대신 코드를 고치면 문서가 따라오는 구조가, 팀 신뢰의 기반이 됐습니다.
API 문서는 팀 소통의 공용어이고, 자동 생성 도구가 그 공용어를 항상 최신 상태로 유지해준다고 생각합니다.