先看看微博和淘宝的API设计
http://open.weibo.com/wiki/%E5%BE%AE%E5%8D%9AAPI
http://open.taobao.com/api/api_list.htm
在线编写API的工具
apiary.io是一个帮助设计API的网站。
API设计时很难得。apiary.io想帮助大家设计漂亮得API。
打开网站
点击看看它时怎么工作得,或者直接用github账号登陆,系统会提示你新建一个项目,并为你初始化了一个API文档。如下图:
左边是编写得API文档,基于markdown语法,右边时效果(点击右上角preview弹出)。
文档里包括了API的url,提交和返回的数据,对数据得解释等。
当点击保存后,点击Documentation来到,如下图。
右边的Mock Server是这个API得模拟器,可以直接访问并返回刚才文档里定义得数据,我们得API就可以测试了,哇哇。
测试得结果
还有一个追踪请求功能,相当靠谱。点击Traffic Inspector可以看到每次请求得情况和每次请求得细节。