(멘토링 3)백엔드 API 구축/2주차 : API 가이드 작성, Rest API?2 2. API 가이드 문서 작성하기 카카오 예시를 보고 API문서 가이드 작성을 진행해봅니다. API 가이드 문서는 데이터를 어떻게 주고 받을 지에 대한 개발자간의 소통입니다. 경우에 따라 팀간의 소통, 백엔드와 프론트엔드 개발자 간의 소통 방법입니다. 클라이언트(프론트엔드)개발자가 서버에 어떤 값을 넘기면 어떤 데이터를 응답해줄 지 에 대한 이야기입니다. 경우에따라 해당 데이터를 어떤식으로 활용할 지 예시를 함께 작성하기도 하지만 간단히 어떤 데이터로 응답하는 지에 대한 문서로 작성하기도 합니다. 아래와 같이 샘플을 제공해드리며 해당 내용을 보고 백엔드 API 만들기 과정에서 필요한 API를 직접 정의(API 제목, API 기능)하여 만들어 보시기 바랍니다. 아래 문서에서 확인할 내용은 요청URL, 요청 Parameter, 응답 바디 입.. 2020. 8. 30. 1. 기술가이드, API 문서 등 업무를 위해 소통하는 법 개발환경 셋팅은 잘 완료하셨을 것이라고 생각합니다. 이번에는 개발자간에 소통을 위한 문서인 API에 대해 알아보려고 합니다. 그리고, 여러분들이 구현하실 API 문서를 직접 작성해보실 겁니다. API 문서를 작성하는 작업은 귀찮은 작업일 수 있지만 개발자간의 소통을 위해 매우 중요한 작업입니다. 개발자들이 어떻게 소통을 하는지 여러분들이 경험 할 수 있는 대표적인 예이니 직접 실무를 한다는 생각으로 진행해보시길 바랍니다 :) 먼저, 아래 내용은 우리에게 공개되어 있는 개발자간 혹은 회사간 혹은 외부 개발자를 위한 문서들입니다. 실무에서는 아래와 같은 방법으로 소통을 하고 있습니다. [업무를 위해 소통하는 다양한 문서] 1) T map API http://tmapapi.sktelecom.com/main.h.. 2020. 8. 29. 이전 1 다음
