#1
https://jojoldu.tistory.com/719
100미터 17초에 달리기
최근에 교육생분들을 대상으로 신입 개발자를 준비할때 있었던 일들에 대해 이야기를 나누는 시간을 가졌다. 이제막 개발을 시작하게된 분들도 계시고, 컴퓨터 공학을 전공했지만 계속해서 취
jojoldu.tistory.com
#2
https://jojoldu.tistory.com/720
좋은 API Response Body 만들기
기존 SSR 시스템(jquery + Server Template)을 API 기반의 신규 시스템으로 전환하는 작업을 하면서 팀의 백엔드 개발자분들께 Response Body 관해서 종종 코멘트를 한다. 이런 코멘트들이 쌓이다보니 그냥
jojoldu.tistory.com
body 값에 boolean 타입이 null인데도 들어가있는 경우가 프로젝트에 꽤 있어서 요 부분 인지하고 개발하면 좋겠다는 생각이 들었다..!
API 문서를 보거나 API 문서를 성실하게 업데이트하지 않았다면..(클라 개발자와만 이야기가 된 경우라면) 코드를 확인해봐야하는데 문자열로 표현되면 좋을 것 같다
단일 객체의 경우는 아니지만 복수형 객체의 경우 빈 값을 빈 배열로 사용해보자.
response body만 보고 이 필드다! 하고 생각하기엔 조금 무섭긴 하다..(필드명을 알아보기 쉽게 만들었어도 실제 구현이 다를수도 있으니까..)
API 문서를 되도록 확인하며 신중을 기하는게 좋지만 그럼에도 직관적인 필드 명명은 좋은 것 같다.
글을 읽으면서 제일 중요하다고 생각했던 부분은 아래이다.
사용하지 않는다면..! 필드는 반드시 삭제하는게 좋은 것 같다
사용하지 않는 필드를 남겨둔다는 건 이후 해당 API의 히스토리를 전혀 모르는 개발자에게 '이거 혹시 필요한거 아니야..?' 와 같은.. 큰 고민을 안겨주고.. 이런식으로 필드가 쌓이면 API에 안 쓰이는 필드가 한바가지가 될 거다..