API는 어떻게 활용하나요?
기획자가 공부하는 API Part.2
PM으로 일하며 개발자들과 원활히 소통하기 위해 개발 지식의 필요성을 절실히 느끼고 있다. 특히, 최근 진행 중인 프로젝트에서 자주 등장하는 개념들을 이해하고자 공부를 시작했다. 이 글은 나처럼 비전공자로서 개발자들과 협업하며 비슷한 고민을 겪는 PM이나 기획자들에게 작은 도움이 되길 바라는 마음으로 작성되었다.
이전 글에서는 API(Application Programming Interface)의 개념을 다루었습니다. API란 소프트웨어 애플리케이션 간 상호작용을 가능하게 하는 규칙과 도구의 집합을 의미합니다. 또한, 네이버가 제공하는 OPEN API 문서를 예시로 들어, PM이 API 문서를 이해할 때 어떤 부분을 중점적으로 살펴봐야 하는지 설명했습니다.
지난 글 링크 : API가 무엇인가요?
오늘은 지난번에 살펴보았던 네이버 OPEN API 문서(네이버 검색 > 책 API)를 기반으로 실제 API 호출하는 방법을 진행하려고 합니다. API 문서를 활용하는 방법을 직접 경험하면서 API에 대한 이해도를 높이는 것이 목표입니다.
1. Postman 회원가입하기
Postman이란? API 개발을 보다 빠르고 쉽게 구현 할 수 있도록 도와주며 개발된 API 테스트를 도와주는 웹사이트입니다. (아래 링크로 들어가 회원가입을 진행합니다)
2. API Request 하기
회원가입을 완료하고 보이는 아래와 같은 화면에서 "New Request"라는 버튼을 통해 새로운 API를 Request할 수 있습니다.
그 이후에 신규 API Request를 위해 New를 선택하면, 아래와 같은 선택지가 나옵니다. 오늘 저희는 HTTP Request를 진행합니다.
여기서 질문! 왜 HTTP Request를 선택해야할까요? 정답은 지난 글에서 참고한 네이버의 OPEN API의 프로토콜이 HTTP이기 때문입니다. (지난 글 링크 : API가 무엇인가요?) 오늘 우리는 해당 API를 요청하려고 합니다.
HTTP를 선택하고 나면 아래와 같은 화면이 나옵니다. 아마 이전 글을 읽으신 분들이라면 더이상 어색하지 않을 단어들이 보입니다. GET, Paramaeter, Headers, Response 같은 단어는 처음에 어려웠지만 이제는 익숙해진 단어들입니다.
이제 API 문서를 보면서 해당 내용을 하나씩 채워가면, 요청한 API에 대한 응답을 받을수 있습니다. 실제 프로젝트를 하면서 개발을 하는 모습도 이와 비슷합니다. API 문서를 통해 API에 대한 이해를 하고, 해당 데이터를 요청한 이후 응답값을 확인합니다.
3. 네이버 클라이언트 아이디와 시크릿 받기
이제 API 문서를 보면서 해당 내용을 하나씩 채워나가보겠습니다. API 문서에서 가장 먼저 진행하는 부분은 인증 절차입니다. 어떠한 클라이언트가 API 요청을 하였는지 확인할수 있도록 클라이언트 아이디와 시크릿을 추가해야합니다. (네이버 클라이언트 아이디와 시크릿 발급 방법)
4. API Request하기
위에 링크를 통해 클라이언트 아이디와 시크릿 받았다면, API Request를 할 단계입니다. 오늘 우리는 네이버 책 검색 API를 통해 한강 작가님의 책을 검색해보도록 하겠습니다. 네이버 API에서 제공하는 요청 URL을 GET에 넣어주고 Parameter로 query에 한강을 넣습니다. 또한 Header 부부분에 앞서 발급 받은 네이버 클라이언트 아이디와 시크릿를 입력합니다. 이를 통해 우리는 네이버 책 검색 API에 한강 작가님을 요청하게 됩니다.
네이버 책 검색 API에 한강 작가님 요청하기
앞서 받은 네이버 클라이언트 아이디와 시크릿 넣기5. API 결과값 확인하기
Send를 선택해 API를 요청하면, 다음 이미지와 같이 응답값을 받을수 있습니다. 보시면, <title>에는 Naver Open API라는 명칭으로 우리가 요청한 API 명칭이 나오고 <item> 하위로 한강 작가님의 소년이 온다에 정보가 나오고 있음을 확인할수 있습니다. 그 아래로는 계속 <item>이 나오면서 우리가 요청한 한강 작가님의 책에 대한 정보를 받아볼수 있습니다.
오늘은 네이버 책 검색 API를 활용하여 Postman을 통해 API를 호출하는 과정을 실습했습니다. API 요청을 수행하는 방법과, API 문서를 읽고 필요한 정보를 추출하는 방법을 익혔다면, 실무에서도 개발자와의 협업이 한층 수월해질 것입니다.
긴 글 읽어주셔서 감사합니다.
