写点什么

Kevin Montrose 谈 StackExchange API 的历史与错误

  • 2011-08-28
  • 本文字数:1158 字

    阅读完需:约 4 分钟

为现有站点创建公开 API 总是一件很有风险的事情,而且 StackExchange 的开放编辑策略则将这种风险更进了一步。在最近发表的一系列文章中,Kevin Montrose 谈到了关于 StackExchange API 的决策以及从中得到的经验与教训。

在开始设计 API 时,他们就已经设定好了目标与约束。比如说,他们的一个主要目标就是“让开发者无需查阅其站点”。StackExchange 成员所遵循的内容许可协定 cc-wiki 可以让第三方重用站点上的内容,但在该 API 发布前,并没有很好的方式进行批量访问。最大的一个约束在于 API 是只读的, Kevin 说到

显然,写操作是非常危险的。不仅仅出现在有 Bug 的认证上,比如有人以 Jeff Atwood 登录,删除了大量的内容,这会让我寝食难安。更重要的是(也是更危险的),在疏于指导的情况下,这会导致人们发布大量的垃圾信息。 我们为了确保 Stack Exchange 内容的质量付出了艰辛的努力(我们关闭了不满足标准的整个站点)。未经深思熟虑的写操作 API 会导致很多问题,因此我们在 1.0 中并没有将其添加进来。不过,我们有可能在 3.0 中将其添加进来。

Kevin 提到了一些关键的设计点:

  • 矢量化请求:“无论何时,如果我们能接受一个 id,那么我们就可以接受 100 个”
  • 压缩的响应:我们使用 GZIP 对响应进行压缩,即便客户端并没有要求压缩我们也会这么做
  • 排序与过滤:“大多数端点可以接收 sort、min、max、fromdate 以及 todate 参数进行查询”

但人们更感兴趣的是他们所犯的错误。比如说,默认情况下返回总数的决定。

总数对于分页控件的渲染很有用,count(*) 查询就是如此(比如说人们对我的评论的投票数等等);从这个角度来说,total 字段本身并没有错。但默认情况下返回它则毫无疑问是不对的。 问题在于总数是有用的,但却并非总是如此。很多时候,查询形式是这样的:“返回标记为 X 的最近的 N 个问题 / 答案 / 用户,或是返回你所拥有的前 N 个问题 / 答案并且根据 S 排序”。这些常见的查询与总数没有任何关系,但每次却都要返回总数,这就需要付出代价。

另一个问题在于对隐式类型的使用。相对于显式说明返回哪个数据类型来说,客户端开发者需要从现有的字段中进行推断。无论在何种语言中这都是非常恼人的问题,但对于静态类型语言来说更是如此,因为开发者需要将这些无名类型映射到实际的类上。

暂且不表其他的错误,让我们使用 Kevin 提到的最后一个错误来作为结论,那就是浪费的请求量。为了防止过度使用 API,他们使用了与 Twitter API 一样的配额。

这实在是太浪费带宽了,与 Twitter 不同,我们的配额还是相当慷慨的(每天 10,000 个请求)并且不是动态的。对于 total 字段来说,很多应用并不需要关注配额(除非超过了,但这种情况很少发生),但如果每次请求都获取该字段则需要付出代价。

查看英文原文: Kevin Montrose on the History and Mistakes of the StackExchange API

2011-08-28 09:171172
用户头像

发布了 88 篇内容, 共 262.3 次阅读, 收获喜欢 8 次。

关注

评论

发布
暂无评论
发现更多内容

为什么?为什么要先问目的?(27/28)

赵新龙

28天写作

百度智能云 AI 公有云服务市场,连续五次第一!

百度大脑

人工智能

慢跑的正确打开方式

wood

跑步 28天写作

2021年全国人工智能大赛正式启动,396万奖金等你报名!

OpenI启智社区

人工智能大赛

软件设计之非功能性

xcbeyond

软件设计 28天写作 12月日更 非功能性

性能即天元:vivo S12的落子与棋局

脑极体

过冬

搬砖的周狮傅

随笔杂谈

第一财经年终总结

石云升

读书笔记 28天写作 12月日更

启梦行动再扬帆 | 2021启智社区优秀项目&优秀开发者评选结果重磅揭晓

OpenI启智社区

启智社区 优秀开发者 优秀开源项目

Go 语言快速入门指南:第七篇 方法

宇宙之一粟

12月日更

Go+ 结构体方法定义教程

liuzhen007

28天写作 12月日更

低代码实现探索(十一)流程中的动作执行器

零道云-混合式低代码平台

从AI前沿到科技自立:百度大脑的风向标意义

脑极体

盘点2021(一)

圣迪

复盘 盘点 2021

绩效评估的why&how

mtfelix

28天写作

黑客是怎么盗取你的密码的?

喀拉峻

黑客 网络安全

.NET中的Husky工具

喵叔

28天写作 12月日更

记录与 Electron 的第一次亲密接触

何佩弦

跨平台 Electron

一文了解 Redis 内存监控和内存消耗

程序员历小冰

redis 28天写作 12月日更

绘制监控页面的一些最佳实践

耳东@Erdong

最佳实践 监控 28天写作 12月日更

如何让TiDB在云上智能运维 (TiDB Hackathon 赛题)

如果迎着风就飞

云原生 operator TiDB Operator 存储上云

从0到1带你深入理解log4j2漏洞

网络安全学海

网络安全 信息安全 渗透测试 WEB安全 安全漏洞

低代码实现探索(十)流程执行器

零道云-混合式低代码平台

Dubbo 框架学习笔记十四

风翱

dubbo 12月日更

c语言学习笔记2021/12

姬翔

react源码解析18事件系统

buchila11

React

几个超火的编程网站,别错过!

程序员鱼皮

CSS JavaScript html 前端 后端

HarmonyOS(鸿蒙)——滑动事件之上下左右滑动

李子捌

28天写作 21天挑战 鸿蒙开发 12月日更

为什么很难得出结论

将军-技术演讲力教练

26《重学JAVA》--网络编程之Socket类

杨鹏Geek

Java25周年 28天写作 12月日更

Dubbo 框架学习笔记十五

风翱

dubbo 12月日更

Kevin Montrose谈StackExchange API的历史与错误_SOA_Jonathan Allen_InfoQ精选文章