많은 web 2.0 서비스들이 자사의 서비스를  다른 서비스에서 활용할 수 있도록 OpenAPI를 개방하고 있지만, OpenAPI를 활용하여 코딩을 하는 것은 개발자들에게도 여전히 부담스러운 일인 것은 분명할 것 같습니다.

 

이러한 수고스러움을 어느정도 덜어주기 위해서는 라이브리러에 사용되는 함수의 파라미터를 form형태로 바꾸어 대화형으로 만들어준다면 프로그래밍에 따른 오류도 상당수 줄일 수 있을뿐만아니라 OpenAPI의 동작원리(입력과 예상 출력과의 관계이해)도 충분히 이해하는데 많은 도움이 되겠지요. 물론, 별도의 coding 작업도 필요없이 대화형 폼에 입력한 사항들로 만들어진 호출 URL도 만들어준다면 더 없이 좋겠죠 ?

 

Youtube API가 대표적으로 이러한 대화형 코딩방식을 지원합니다. 지원가능한 command는 다음과 같습니다.

 

아래의 화면에서 알 수 있듯이, Video관련 입력질의어를 만들고 파라미터들을 설정하면, 자동적으로 요청 URI가 생성하며 생성된 URI를 전송하면 지정된 output format에 따른 출력결과를 전송받을 수 있습니다.  

 

 

요청 URI와 회신된 결과를 확인할 수 있으므로 OpenAPI 사용에 따른 오류 발생 시 오류 원인을 찾는 경우에도 편리하게 이용할 수 있을 것 같네요.

 

참고로 OpenAPI 테스팅을 위한 interactive form을 제공하는 사이트 몇가지를 소개하면 다음과 같습니다.

 

 

웹 서비스에서 OpenAPI를 개발하고 오픈한다는 것은 단순히 개발 코드와 URI를 오픈한다는 의미를 넘어서 오픈된 OpenAPI를 어떻게 코딩하고 사용할지에 대해서도 풍부한 정보들을 제공해야함을 의미하며, 좀 더 나아가서 Youtube의 API와 같이 대화형 코딩을 통해 좀 더 쉽게 OpenAPI 사용 경험을 습득할 수 있도록 함으로서 OpenAPI의 활용도를 높일 수 있다는 점에서 매우 유의미하다고 생각됩니다.

 

개발자 이외에 기획자나 디자이너도 대화형 코딩 폼을 통해서 자신이 기획하고 디자인할 OpenAPI의 결과 형식을 미리 알수 있도록 해준다는 점에서 OpenAPI를 오픈할 계획을 가지고 계신 스타트업들은 한번쯤 Youtube API의 대화형 코딩방식을 참고하시면 도움이 되실 것으로 생각되네요.

Posted by pletalk