게시판 만들기 - API 설계

API 설계를 구글 문서롤 작성한다. 뷰와 api에 어떤 방식으로 url이름을 지정할 것인지, method 방식은 어떻게 할 것인지, 해당 url의 설명과 함께 문서를 작성한다.

url은 다른 협업 개발자가 봤을 때고 직관적으로 어떤 항목에 관련된 url인지 파악할 수 있게 작성하는 것이 중요, 이에 대한 방법은 왕도가 없으니 협업 개발자들과 합의를 통해 지정해야한다. 지금 작성한 것이 정답은 아님.

지금은 경로와 http 메소드만 작성한 것인데, 여기서 api의 spec을 작성한다. api에 정확히 어떤 데이터들을 주고받는지를 생각해볼 수 있다.

이렇게 사용자가 회원 가입을 할 때, id, 비밀번호,이메일,닉네임,메모와 같은 데이터가 입력된다거나, 사용자가 게시판을 작성할 때, 제목,본문,id,해시태그가 입력된다 같은 방식으로, 사용자가 어떤 작업을 진행할 때, 어떤 데이터가 오고 가는지를 개략적으로 파악하면, 개발진행이 수월해 질수 있다.

이렇게 api 설계는 마무리 되었다.