1. 기술가이드, API 문서 등 업무를 위해 소통하는 법

개발환경 셋팅은 잘 완료하셨을 것이라고 생각합니다.

이번에는 개발자간에 소통을 위한 문서인 API에 대해 알아보려고 합니다.

 

그리고, 여러분들이 구현하실 API 문서를 직접 작성해보실 겁니다.

API 문서를 작성하는 작업은 귀찮은 작업일 수 있지만 개발자간의 소통을 위해 매우 중요한 작업입니다.

개발자들이 어떻게 소통을 하는지 여러분들이 경험 할 수 있는 대표적인 예이니

직접 실무를 한다는 생각으로 진행해보시길 바랍니다 :)

 

먼저, 아래 내용은 우리에게 공개되어 있는 개발자간 혹은 회사간 혹은 외부 개발자를 위한 문서들입니다. 실무에서는 아래와 같은 방법으로 소통을 하고 있습니다.

 

[업무를 위해 소통하는 다양한 문서]

 

1) T map API

http://tmapapi.sktelecom.com/main.html#web/guide/webGuide.sample3

Guide | T MAP API

T map api 에서는 T map을 활용할 수 있는 방법에 대해 안내하고 있습니다.

Android/ios/web 에서 어떻게 사용하면 되는지 그리고 어떤 기능을 제공하고 있는지를 자세히 설명하고 있습니다.

맵 데이터가 다양한 곳에서 활용되어야 서비스가 확장될 테니 T map API를 잘 사용할 수 있도록 하는 것은 매우 중요한 일입니다. 외부 개발자가 해당 내용을 활용해서 개발할 수 있도록 API 문서를 작성하는 일은 해당 API를 만든 개발자의 머리에서 나옵니다 :) 

 

2) 하나은행 오픈 플랫폼

https://openapi.kebhana.com/?gclid=Cj0KCQjw-af6BRC5ARIsAALPIlU0wE5g_fMGtcrVDs1r1lYB5CH2in9hWeAnqTXKP8kIMRTPkU-1oucaAjYBEALw_wcB#/use-step-info

portalApplication

해당 페이지는 하나은행 API를 사용하기 위한 절차도 함께 소개하고 있습니다. API 이용신청을 하고 약정에 따른 개발을 하고 있는데요. 이 역시 업체간, 개발자간 소통을 위한 문서 중 하나입니다.

큰 그림에 대한 API 이용 절차는 개발자와 기획자 혹은 영업자간의 소통을 통해 만들어지는 결과물일 것이며 때론 QA가 작성하는 문서가 될 수도 있겠습니다.

 

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

(2차)kakaoAPI_참고문서_관심_키워드분석

해당 내용은 한 가지 기능에 대한 API 가이드 문서입니다. 카카오 관심 키워드 데이터셋 API가이드 문서인데요. 중요하게 생각하셔야 하는 부분이 요청URL, 요청 파라미터, Response 이 세 가지가 될 것입니다.

결과를 위한 입력값을 전달하면 서버는 그 입력값을 바탕값으로 출력값을 전달해줍니다.

그럼 이 출력된 값을 가지고 개발을 이어서 진행하겠죠?!

한 가지 주제에 대한 카카오 API 문서는 3) 라인페이 관련 문서와는 다른 간단한 API 문서임이 눈길이 갑니다.

 

5) Kakao 방문자 데이터셋 API 가이드 문서

www.notion.so/2-kakaoAPI_-_-_API-b956f0b392434e4f9b05bc326db0ca89

(2차)kakaoAPI_참고문서_방문자 데이터_API

 4) 케이스와 일치하는 한 가지 주제에 대한 API 가이드 문서입니다.

 

 

위 5가지 내용에서 개발자간의 소통방법, 업체간의 소통 방법 때론 완전히 오픈해버린 API문서, 한 가지 주제에 대한 API문서, 전체 기능에 대해 정리된 API 문서 등 다양한 소통방법을 이해해 보셨을 거라고 생각합니다.

 

저는 4번째 방법으로 API문서를 한번 작성해보겠습니다.

다만 여러분은 3번째 방법으로 API문서를 작성해보는 것도 좋을 것 같습니다.

여러분들은 다양한 API를 만들어보고 총괄적인 3번째 API문서를 직접 작성해보시길 추천드립니다.

선택은 여러분들에게 맡기겠습니다.

 

 

참고) 미리보는 3주차 내용

REST API 장점에 대해 한번 이야기를 던져 보겠습니다.

3주차 시간에는 간단한 Rest-API를 구현해 볼 텐데요. 

 

그 때 학습하신 내용을 바탕으로 아래 장점의 이유를 이해해볼 수 있는 시간이 되시길 바랍니다.

 

https://blog.naver.com/dktmrorl/222072210416

[IT정보] REST, REST API, RESTful 개념

https://not-null.tistory.com/26

REST API 장점