API 문서를 작성하는 작업은 귀찮은 작업일 수 있지만 개발자간의 소통을 위해 매우 중요한 작업입니다. 개발자들이 어떻게 소통을 하는지 여러분들이 경험 할 수 있는 대표적인 예이니 직접 실무를 한다는 생각으로 진행해보시길 바랍니다 :)
먼저, 아래 내용은 우리에게 공개되어 있는 개발자간 혹은 회사간 혹은 외부 개발자를 위한 문서들입니다. 실무에서는 아래와 같은 방법으로 소통을 하고 있습니다.
[업무를 위해 소통하는 다양한 문서]
1) 쿠팡 API
https://developers.coupangcorp.com/hc/ko/articles/360033644894-상품-승인-요청
쿠팡은 외부 판매자들이 쿠팡 플랫폼에서 상품을 효율적으로 관리할 수 있도록 다양한 API를 제공합니다. 상품 등록, 재고 관리, 주문 처리, 배송 관리 등 판매자에게 필요한 다양한 기능을 API로 제공하여 자동화된 상품 관리가 가능하도록 지원하고 있습니다.
이러한 API들은 외부 개발자들이 쉽게 이해하고 활용할 수 있도록 상세한 문서화가 되어 있으며, 각 API의 사용 방법, 파라미터, 응답 형식 등이 명확하게 설명되어 있습니다.
2) 빗썸 API
https://apidocs.bithumb.com/reference/마켓코드-조회
빗썸 API 를 이용하여, 가상화폐의 가격, 차트는 물론 거래까지 할 수 있는 API를 제공하고 있습니다.
해당 API를 이용해 새로운 서비스를 만들기도 하며, 퀀트 투자라는 투자를 시스템화하여 사용하고 있는 사례들을 많이 볼 수 있습니다.
3) LINE Pay 기술 연동 가이드
https://pay.line.me/file/guidebook/technicallinking/LINE_Pay_Technical_Linking_Guide_for_Normal_Merchant_v1.0.1_ko.pdf
해당 내용은 라인페이의 외부 가맹점용 가이드 문서인데요. 목차를 보시면 라인페이 가맹점 등록과정과 API 가이드가 상세히 적혀있습니다. 결제 예약/승인/조회 등 각 기능에 대한 API를 가이드하고 있는데요. API 사용예제 역시 참 상세히 써있습니다. API는 수정될 수 있는 사항이니 변경될 수 있다는 조항 역시 눈 길이 갑니다.
이렇게 API를 가이드하는 구나!라고 이해해 보셨으면 좋겠는 아주 좋은 예제 입니다.
4) KaKao 관심 키워드 데이터셋 API 가이드 문서
www.notion.so/2-kakaoAPI_---f7b315aac02f4fe5a2823921b7c61a18
해당 내용은 한 가지 기능에 대한 API 가이드 문서입니다.
결과를 위한 입력값을 전달하면 서버는 그 입력값을 바탕값으로 출력값을 전달해줍니다.
그럼 이 출력된 값을 가지고 개발을 이어서 진행하겠죠?!
한 가지 주제에 대한 카카오 API 문서는 3) 라인페이 관련 문서와는 다른 간단한 API 문서임이 눈길을 끕니다.
5) Kakao 방문자 데이터셋 API 가이드 문서
www.notion.so/2-kakaoAPI_-_-_API-b956f0b392434e4f9b05bc326db0ca89
위 내용을 살펴보면, 결국 API 명세서는 개발자간의 소통방법, 업체간의 소통 방법 때론 완전히 오픈해버린 API문서, 한 가지 주제에 대한 API문서, 전체 기능에 대해 정리된 API 문서 등 다양한 소통방법을 이해할 수 있는 협업의 도구입니다.
참고) 미리보는 3주차 내용
REST API 장점에 대해 한번 이야기를 던져 보겠습니다.
3주차 시간에는 간단한 Rest-API를 구현해 볼 텐데요.
그 때 학습하신 내용을 바탕으로 아래 장점의 이유를 이해해볼 수 있는 시간이 되시길 바랍니다.
REST, REST API, RESTful 개념