기획자인 내가 아직까지 API가 헷갈렸던 이유 -실전
직접 안 해봤으니까!개념 정리부터, API 호출까지 쉽게 도전해보자!
API 딱 한번 호출하고 약 5년 간 안 까먹기
기획자도 API 호출을 테스트해볼 수 있다! 뼛속부터 문과생인 나도 한 번에 성공했다. 한번 API를 호출해보고 나니, 확실히 API란 무엇이며 어떤 개념을 꼭 써야 하는지 오랫동안 기억할 수 있게 됐다.
우린 능히 할 수 있다. 그러면 두말 말고 한번 시작해보도록 하겠다.
그전에 API에 관련해 기본적인 설명이 필요하다면, 아래 글을 참고하자
준비 사항
1. POSTMAN 계정 만들기
Postman은 API 개발을 보다 빠르고 쉽게 구현할 수 있도록 도와주며, 개발된 API를 테스트하여 문서화 또는 공유할 수 있도록 도와주는 플랫폼이다. 아래 링크로 이동해 회원가입을 완료하면 무료로 이용해볼 수 있다.
(PC 앱 다운로드를 유도하지만 하지 않아도 된다.)
2. 테스트할 API 찾기
사용할 수 있는 API라면 무엇이든 괜찮다. 하지만 마땅하지 않다면, 네이버 Developers에서 다양한 API를 무료로 이용해볼 수 있다. 네이버 회원이라면 바로 시작 가능하고 재미있는 API가 많아서 개인적으로 추천!
https://developers.naver.com/main/
시작해보자!
1. Postman에서 Http Request 실행하기
Workspace를 하나 생성하면 아래와 같은 화면이 나오는데, 여기에서 좌측 상단에 있는 'NEW'를 선택하고 HTTP Request를 선택한다.
2. NAVER Developers에서 원하는 API 찾아보기
아래 개발자센터에서 원하는 API를 골라본다. 나는 한글 인명-로마자 변환 API를 선택했다.
https://developers.naver.com/docs/papago/papago-romanization-overview.md
3. API 사용을 위해 애플리케이션 등록하기
API를 사용하려면 애플리케이션 등록이 필요하다. 네이버 로그인 후 GNB의 Application > 애플리케이션 등록을 완료한다. 애플리케이션 이름은 마음대로 지으면 되고, 서비스 환경은 웹으로 선택 후 아무 사이트나 입력해도 상관없다. 단 사용 API에는 본인이 테스트할 API를 선택한다.
4. 내 Client ID/Client Secret 확인
최종 등록 후 내 애플리케이션으로 들어가면, 생성한 애플리케이션을 확인할 수 있는데, 여기에 Client ID와 Client Secret 값이 있다. 이 부분은 나중에 호출 시 ID/PW로 사용하므로 여기에서 찾을 수 있다는 점을 잊지 말자.
5. API 문서를 보고 Postman에 입력하기
이제 내가 사용할 API 문서로 이동한다. 우리가 할 것은 이 문서를 보면서 Postman에 기입하는 것뿐이다.
6. 요청 URL, HTTP 메서드 입력
우리가 공부했던 대로 API 문서에 1) 요청 URL, 2) HTTP 메서드가 보인다. Postman에도 넣어주자
7. Client ID/ Client Secret 입력
앞서 말했듯이, 우리가 누군지 밝히기 위해 헤더에 Client ID와 Client Secret 값을 같이 넣어주어야 한다. API 문서에 적혀 있는 대로 헤더에 Key와 아까 발급받은 Value를 입력한다.
8. 파라미터 입력
마지막으로 파라미터 값을 입력해야 한다. 어떤 이름을 로마자로 번역 하고 싶은지 API에 적어서 요청해야 한다. 그렇지 않으면 API는 정보를 입력받지 못했으므로 에러 응답을 보낼 것이다.
한글 인명-로마자 변환 API의 경우 한 개의 파라미터 값만을 필요로 한다. 이 값을 Postman의 Params에 적어준다. API 문서에 적혀있는 대로 URL에 직접 적어주어도 무방하지만, Params에 적어주는 것이 더 편리해서 이 방식을 선택했다. 파라미터에 query와 내가 검색할 value인 서강준을 입력해주었다.
9. 입력 완료 후 Send 버튼 선택
나는 아래와 같이 서강준 씨에 대한 로마자 변환 결과를 얻었다! API 문서를 보니 sFirstName과 name, score에 대한 해석이 있으므로, 어렵지 않게 결과값에 대해 해석해볼 수 있었다. Seo Kangjun이 가장 표준 로마자 변환 결과로 볼 수 있다.
{
"aResult": [
{
"sFirstName": "서",
"aItems": [
{
"name": "Seo Kangjun",
"score": "99"
},
{
"name": "Seo Gangjun",
"score": "84"
},
{
"name": "Seo Kangjoon",
"score": "76"
}
}
]
}
]
}
※ 에러 응답을 받았다면?
만약 정상적인 응답을 받지 못했다면, 받은 에러 값을 API 문서에서 찾아보면 된다. 각 에러 케이스에 대해 무엇을 확인해봐야 하는지 상세하게 기재하고 있다.
개발자만의 영역이라고 생각했던 API 호출을 직접 해보니 좀 더 메커니즘을 쉽게 이해할 수 있었다. 이론도 중요하지만 실제로 부딪히며 배우는 경험을 무시할 수 없다는 말에 좀 더 공감할 수 있게 되었다. 위에 있는 설명으로도 API 호출이 어렵다면, 아래 유튜브 영상을 참고하자. 차근차근 쉽게 설명해주시기 때문에 누구나 따라 할 수 있다.
