[이룸] 240131 API 명세 및 ERD 작성에 대한 회고

 

🔥 해당 API에 관련하여 팀원분이 의견을 주셨습니다. 의견은 아래와 같습니다.

 

 

• RESTful한 api 문서를 작성했다고 생각했지만, 조회 조건이 복잡해지자 곧 혼란이 야기되었습니다.
• 혼란의 이유에 대해 저는 다음과 같이 생각하였습니다.
  1. 현재 테이블이 challenge, challenger로 나뉘어져 있는데, 이 두 테이블의 이름이 너무 유사하여 의사소통 시 혼란을 야기하였다.
  2. challenger_id를 fk값으로 걸었을 때와 challenge_id를 fk값으로 걸었을 때의 차이가 충분히 논의되지 않았다.
• 따라서 변수명 변경을 제안하고, 각기 다른 id를 fk 값으로 받았을 때의 상황을 가정하여 제시해 보았습니다.

 

• 이후 다음날 해당 사항에 대해 팀원과 이야기를 나눌 수 있었습니다. 여러 상황을 고려해 본 결과 challenger_id를 auth 테이블의 fk로 걸어두는 것이 좋다는 의견으로 좁혀졌습니다.
• 변수명을 수정하자는 제안에는 의견이 갈렸습니다. ‘팀 내의 모든 사람이 이해하고 합의가 되었다면 기존 이름을 고수하자. 왜냐하면 이름의 변경은 또 다른 혼란을 야기하기 때문’이라는 의견과 ‘challenge’와 ‘challenger’, ‘r’ 하나 차이인 ‘이름에 오타가 생길 수도 있고, 그런 실수는 너무 작아서 찾기도 힘들 테니 지금이라도 변경하자’는 쪽으로 의견이 갈렸습니다.
• 저는 ‘이후에 구현될 복잡한 기능들을 고려하여, 지금이라도 단순한 이름으로 변경해야 한다’는 쪽에 마음이 기울었는데요…! 이를 주장하기 전에, ‘challenger’ 대신 사용할 적절한 테이블명이 있는지를 먼저 생각해야 하겠습니다. 새로운 이름이 지금보다 좋다면 팀원들을 설득할 수 있을 테니까요!