안녕하세요 세오스의 14기 개발자 여러분

7주차 스터디 진행을 맡은 프론트엔드 파트장 김선종🧑🏻‍💻 백엔드 파트장 이수연👩🏻‍💻입니다.

🔥빡세기로 소문이 자자한(?)🔥 ceos 개발 스터디가 막바지를 향해 달리고 있습니다. 6주차 스터디까지 진행하시면서 어느정도 django와 친해지셨을 것이라고 생각이 됩니다✨

따라서 마지막 스터디 과제는 실제 팀프로젝트에 들어가기에 앞서 이제까지 배우신 것들을 조금이나마 더 활용해보실 수 있도록 프엔 백엔이 팀을 맺어 협동스터디를 진행하려고합니다.

(협동스터디 팀은 이후 진행될 팀프로젝트를 위해서 기존 팀 멤버와 같습니다.)

제대로된 과제설명에 들어가기 전에 팀프로젝트때 도움이 될 만한 주제들을 소개하려고합니다

1. API 문서

프론트엔드와 백엔드가 서로 통신에 사용할 API에 대해 잘 이해하기위해 작성된 **API 사용방법에 관한 문서**라고 생각하시면 됩니다.

API문서에는 요청에 필요한 URI, method종류, query, header에 들어갈 것들, body에 들어갈 data 등등에 대한 부분이 정확하게 들어가야합니다. 그리고 요청을 보냈을 때 받을 수 있는 응답(data, status code....)에 대해서도 작성해주어야합니다.

물론 swagger, gitbook, postman과 같이 API문서작성을 도와주는 서비스가 존재하기 때문에 더욱 간편하게 API문서를 작성하실 수 있습니다

API 문서를 제대로 작성해보자 (feat. insomnia)