2. API 가이드 문서 작성하기

카카오 예시를 보고 API문서 가이드 작성을 진행해봅니다.

API 가이드 문서는 데이터를 어떻게 주고 받을 지에 대한 개발자간의 소통입니다.

경우에 따라 팀간의 소통, 백엔드와 프론트엔드 개발자 간의 소통 방법입니다.

 

클라이언트(프론트엔드)개발자가 서버에 어떤 값을 넘기면 어떤 데이터를 응답해줄 지 에 대한 이야기입니다.

경우에따라 해당 데이터를 어떤식으로 활용할 지 예시를 함께 작성하기도 하지만

간단히 어떤 데이터로 응답하는 지에 대한 문서로 작성하기도 합니다.

 

아래와 같이 샘플을 제공해드리며 해당 내용을 보고

백엔드 API 만들기 과정에서 필요한 API를 직접 정의(API 제목, API 기능)하여 만들어 보시기 바랍니다.

 

표지 및 변경사항

아래 문서에서 확인할 내용은

요청URL, 요청 Parameter, 응답 바디 입니다.

어떤 URL로 어떤 파라미터를 넘겼을 때 어떤 응답이 오는지 확인 할 수 있습니다.

 

위 문서에서는 pathVariable 방식으로 응답을 요청하고, JSON 포맷으로 데이터를 응답하는 게 특징입니다.

그리고 API의 특징은 HTTP 통신으로 이루어지고 있습니다.

 

문서를 작성하시며

위 pathVariable, JSON, HTTP 에 대한 키워드를 함께 학습해보시길 바랍니다.

그리고 해당 내용은 다음 차 주 퀴즈문제의 주요 내용이 될 것입니다 :)

 

 

참고) JSON이란?

https://velog.io/@surim014/JSON%EC%9D%B4%EB%9E%80-%EB%AC%B4%EC%97%87%EC%9D%B8%EA%B0%80

JSON이란 무엇인가?