Oct 30, 2023 7 min read 팀 달파

PM이 개발자와 협업하는 법 - API

💡

이런 분에게 추천해요
- 개발자와 효율적으로 소통하고 싶은 PM
- API가 낯선 주니어 PM

예상 소요 시간: 약 7~9분

비개발자가 API를 만났을 때

PM이라면 모르면 안되는 단어, API.
비개발자가 API를 처음 마주쳤을 때,
그 낯섦과 막연한 두려움은 아마 많은 분들이 공감하실 거라 생각해요.

‘PM이 이런것도 알아야 해?’ 라고 생각할 수 있지만,
API는 서비스 개발 전반적인 영역에서 사용되기 때문에
대략적인 이해가 뒷받침된다면 더 효율적인 매니징이 가능합니다.

하지만 그렇다고 기술적으로 깊은 이해가 필수적인 것은 아니에요.
API에 대한 대략적인 원리와 어떤 상황에서 어떤 담당자와 소통해야
하는지를 이해하기만 한다면 충분합니다.

특히 달파는 대부분의 AI 서비스를 API 형식으로 제공하고 있기 때문에
API에 대한 이해가 필수적이었는데요,
비개발자의 시선에서 제가 API와 친해졌던 과정을 공유해볼까 합니다.

API는 레스토랑의 점원이다

위시켓 https://blog.wishket.com/api란-쉽게-설명-그린클라이언트/

API는 레스토랑의 점원이라는 비유가 직관적인데요,
레스토랑에서 음식을 주문할 때를 생각해봅시다.
이때 점원은 손님의 주문을 받아 요리사에게 전달하고,
요리사로부터 음식을 받아 손님에게 전달하죠.

API도 똑같습니다.
프로그램(Client)의 요청을 받아 이 요청을 처리할 수 있는 프로그램에게 전달하고,
처리된 요청의 결과값을 다시 프로그램(Client)에게 전달합니다.
즉, API는 한 마디로 프로그램 간 소통을 도와주는 도구입니다.

API 이해하기

우리가 핵심적으로 알아야 할 부분은 주로 아래 두 가지입니다.

이건 어떤 일을 하는 API인가?
지금 API 단에서 발생한 문제는 어떤 문제인가?

API 문서

1번을 파악하는 데 가장 도움이 되는건 API 문서입니다.
API 문서는 전자제품 사용설명서처럼 생각하면 좋습니다.
모든 내용을 볼 필요는 없고 특정 부분만 확인하면
대략적으로 어떤 역할을 하는 API인지 파악할 수 있죠.

제가 주로 확인하는 건 요청(input) 예시와 응답(output) 예시입니다.

쿠팡의 API 문서를 확인해보겠습니다.
Request/Response Example을 보면 json 형식으로 데이터를 주고받고 있는데요,
json 형식은 키(key)와 값(value)으로 이루어진 하나의 문법입니다.

요청값에 상품명과 여러 정보들을 담아서 보내면,
응답값으로 예측한 카테고리 id와 이름이 반환되는 것을 알 수 있네요.
즉, 이 API는 상품의 이름을 기반으로 카테고리를 추천해주는 API라는 것을 쉽게 확인할 수 있습니다.

404 not found

다음으로 API의 에러상황에 대해 이해해보겠습니다.
‘404 not found’와 같이 에러 코드에는
어떤 종류의 에러인지에 대한 정보가 담겨있는데요,
에러 유형을 구분할 수 있다면 문제의 원인을 짐작하는 데 도움이 됩니다.

정확한 소통, 즉 빠르게 문제를 파악하고
누구에게 무엇을 요청할 것인지 판단하는 데 매우 유용합니다.

[에러 코드]

4XX (클라이언트 오류): 요청값이 잘못된 상태
5XX (서버 오류): 요청값은 잘못없음. 서버가 요청을 처리하지 못한 상태

에러코드가 4로 시작한다면 주로 요청을 보내는 프론트,
5로 시작한다면 주로 요청을 처리하는 백엔드에
문제가 생겼다고 짐작할 수 있습니다.

Open API

서비스를 개발할 때 모든 기능을 내부에서 구현할 필요는 없겠죠.
많이 들어보셨을 Open API는 말그대로 Open되어 있는,
자유롭게 활용 및 공유되도록 설계된 API입니다.

“이거 Open API 있어서 그거 쓰면 됩니다.” 라는 말은
해당 기능을 아주 쉽게 구현할 수 있다는 뜻으로 받아들일 수 있어요.

대표적으로 유튜브, 트위터, 네이버, 카카오 등에서
다양한 기능의 Open API를 제공하고 있습니다.

[Open API 제공 사이트]

트위터: https://developer.twitter.com/en/docs/twitter-api
유튜브: https://developers.google.com/youtube/v3?hl=ko
네이버: https://developers.naver.com/main/
카카오: https://developers.kakao.com/

AI 활용을 위한 API

최근 AI 활용도 마찬가지로 API를 통해 쉽게 이루어지고 있습니다.
chatgpt, whisper 처럼 대용량의 서버가 필요한 AI 모델도
개인이 쉽게 활용할 수 있는 시대가 되었죠.

API를 통해 AI를 활용하는 것은 많은 장점이 있습니다.

사용량 기반 과금으로 유연한 활용
빠른 프로토타이핑과 테스트
지속적인 성능 개선

달파의 많은 AI들도 API 형식으로 서비싱되고 있습니다.
고객사 서비스에 딱 맞는 방식으로 커스텀 제공되기 때문에
활용도가 매우 높고 개발 리소스도 최소한으로 들일 수 있죠.

달파 AI Store 보러가기

마치며

API는 서비스 개발의 아주 많은 영역에서 활용되는 만큼
PM으로서 이를 이해하는 것은 필수적입니다.
기획 단에서 어떤 영역에 API가 활용될 수 있고,
어떤 상황에서 누구와 소통해야 하는지 파악하는 데
이 글이 조금이라도 도움이 되었으면 합니다 🙌