[오늘은] 트러블슈팅 작성 - API 명세서의 중요성

클론 코딩을 하면서 소통 방법에 대해서 느낀 점이 많아 글을 작성해볼까 합니다.

📜 API 명세서의 필요성

• 백엔드는 API 명세서를 바탕으로 기능을 정의하여 작업하고, 프론트엔드는 이를 바탕으로 백엔드에서 어떤 값이 오는지 알고 작업할 수 있습니다.
• 개발 팀 간의 협업을 용이하게 하고, 새로운 팀원이 프로젝트에 빠르게 적응하도록 돕습니다.

🔴 트러블 슈팅

• 문제 정의

  • 실질적으로 들어오는 값과 차이가 생겨 코드를 수정하거나 명세서는 바꾸는 경우가 빈번히 발생했습니다.
  • 예를 들어, 에러를 어떻게 받을 것인지, 토큰 담는 방식 등 API 명세서 작성이 끝난 후에 조율을 하는 상황이 있었습니다.

• 원인 추론

  • FE에서는 피그마 작성, BE에서는 RED, API 명세서 작성으로 나누어 각.자. 작업을 했습니다.

• 해결 방법

  • 플로우차트를 작성하기 FE와 함을 맞춰 화면에 어떤 기능이 필요하고, 어떤 요청을 주고 받을지 조율이 필요합니다.
  • 변수명이 될 간단한 설명 작성하기
  • 플로우 차트 공유하고 싶어서 링크와 사진 남깁니다. 👇
    https://velog.io/@director20844/API-명세-작성하기

🌟 마무리

이와 같이 소통하는 방법이 다양하게 있으면 좋을 듯 싶습니다.
어떻게 하면 더 효율적으로 같이 설계, 개발할 수 있을지 생각해보는 시간이 되었습니다.
모두가 같은 곳을 바라볼 수 있는 양식이 필요하다는게 중요한 것 같습니다.

참고할만한 좋은 자료

• BDD? SDD? 팀 프로젝트 다같이 개발설계하는 방법 https://velog.io/@teo/behavior-driven-development-schema-driven-development