很多园友都在尝试新浪微博API,并且开发了很多应用。开发过程中,API文档的作用很大,参数的取值,返回数据的结构等若描述清晰,将节省开发者大量的摸索时间。豆瓣API的文档虽不完美,已经非常好了。微博API文档,特别是返回数据举例,字段含义说明存在一些和实际不相符的问题,给开发者带来不少麻烦。非常期待能有一个API调试的工具,编辑API参数,发送API请求,方便地查看返回数据。有了想法,于是就开始鼓捣起来,取名“微博API调试台”。
技术方案
做成Web应用,服务器端借助微博SDK完成OAuth认证和API请求发送,返回执行结果给客户端;客户端完成API选择、API请求参数编辑,发送API请求给服务器端,呈现返回的json数据。
服务器端采用python实现,选用bottle+jinja2+beaker,微博SDK使用weibo.py,应用部署在SAE上。客户端选用bootstrap+jquery。
Json数据呈现
显示原始的Json字符串对开发者没有意义,格式化后的Json数据具有一定的缩进结构,但是在查看大量数据时,仍不太方便。采用jsonview.js库,可以将json数据转换为html,对不同的数据类型进行着色,并且可以对嵌套数据进行折叠,在查看大量的json返回数据时,可以快速方便的找到想要的数据段。
实现
仅给出个截图,有兴趣的园友欢迎试用,代码托管在github,敬请指正。
工具地址:http://weiboapidebugger.sinaapp.com
代码托管:https://github.com/gzb1985/weibo-api-debugger
P.S. 有此想法是在8月初,当时实现了一个demo,其后一直停滞,9月中旬惊喜发现微博官方也有了测试工具(http://open.weibo.com/tools/console),很好用。API调试台虽有重复,还是继续进行了完善,也有了一些自己的特点,算是给这个想法一个交代吧。