2021-01-26(Tue)

항목	내용
학습 날짜	2021-01-26(화)
학습 시간	10:00~24:00
학습 범위 및 주제	API 설계
학습 목표	프로젝트에 필요한 API 문서를 작성한다.
동료 학습 방법	팀원들과 API 를 설계하고 문서를 작성하였다.

상세 학습 내용

노션으로 아래처럼 API 문서를 작성하였다.

image

이후엔 postman을 이용하여 서버로 바로바로 api 요청을 보내고 응답을 받아볼 수 있도록 셋팅하였다. swagger에도 있는 기능이라고 하던데, 기능이 비슷하며 postman은 학습비용이 더 들지 않으므로 적절한 선택이었던듯하다.이 과정에서 응답 예시를 하나하나 작성해야했는데, 아래 내용들을 고려하였다.

• REST API 디자인팁 확인 https://spoqa.github.io/2012/02/27/rest-introduction.html https://meetup.toast.com/posts/92

• JSON 포맷팅에 대한 고민 -> rails 기능과 원할한 연동을 위해 스네이크 스타일로 가기로함. https://gist.github.com/subicura/8329767

• 카카오와 rest api 응답 예시를 보고서, header와 body 내용을 정했다. 만약 guild 정보를 요청했을 때 단순히 guild 정보를 json으로 보내 주는 것이 아니라, json안에 guild를 키로 하는 해시의 값으로 json을 묶어서 보내도록 하는 것이 좋은듯. 왜냐하면 에러 발생했을 경우 guild 키 값과 더불어 error 키 해시에 error 내용을 담아서 보내는 방식이 실무에서 많이 쓰이는 듯하기 때문이다.

학습 내용에 대한 개인적인 총평

RESTful 하게 api를 정의하는 것이 무엇일까..란 대화를 계속 나누며 api를 설계해나가는 것이 즐거웠다. api를 설계할 때 생각보다 분기가 많아서 어떤 식으로 api를 짤지 미리 학습해두길 잘한 것 같다. 분기에 필요한 정보를 query에 담을지, body param에 담을지 등등은 직접 구현해봐야 해볼만한 고민인듯하다. 특히 guild에 속한 user를 조회할 때 요청 uri가 guild를 첫 번째 url fragment로 구성되게끔할지 users를 첫 번째 url fragment로 구성되게끔할지 고민되던데, 우리 나름 옳다고 생각하는 방식으로 설계했으나 보통 어떻게 구현하는지 멘토님께 확인 해봐야겠다.

다음 학습 계획

• DB 설계