안녕하세요 17기 개발자 여러분 🙌🏻
7주차 스터디 진행을 맡은 프론트엔드 파트장 오지은✌️, 백엔드 파트장 이정현✌️입니다.
CEOS 개발 스터디가 어느덧 막바지를 향해 달리고 있습니다. 마지막 과제는 실제 팀 프로젝트에 들어가기에 앞서 이제까지 배우신 것들을 조금이나마 더 활용해 볼 수 있도록 합동 스터디를 진행하려고 합니다.
본격적인 과제 설명에 들어가기 전에, 팀 프로젝트에 도움이 될 만한 주제들을 소개해 드리겠습니다.
프론트엔드와 백엔드의 통신에 필요한 API 사용 방법에 관한 문서입니다.
API 문서에는 요청에 필요한 URI, method 종류, query, header, body에 들어갈 data 등이 정확하게 들어가야 합니다. 또한 요청을 받았을 때의 응답(data, status code....)에 대해서도 작성해야 합니다.
물론 swagger, gitbook, postman과 같이 API 문서 작성을 도와주는 서비스가 존재하기 때문에 더욱 간편하게 API 문서를 작성할 수 있습니다.
API 문서를 제대로 작성해보자 (feat. insomnia)