Page 1 of 1

你承诺的那些 API 在哪里?

Posted: Sat Mar 01, 2025 9:41 am
by sakib36
GOV.UK 上的所有编辑内容都可通过 API 完整获取。我们使用相同的 API 在编辑工具和生成您看到的页面的应用程序之间进行通信。

正如我几个月前所说,API 是 GOV.UK 的基础。Martha Lane Fox 的报告 指出,提供高质量的 API 是我们 GOV.UK 工作的一个主要目标。在 API 的基础上构建并牢记 API 一直是我们软件设计中的一个关键架构原则。

读过上一篇文章的人应该已经看到了我们当时用来 哥伦比亚 WhatsApp 号码数据 宣传 API 存在的一些按钮。当我们更详细地研究设计并回到我们的设计规则时,我们意识到对于绝大多数网站访问者来说,这些按钮会分散他们的注意力,使他们无法快速获得我们承诺的满足他们需求的答案。所以这些按钮已经消失了。链接并没有完全消失,有些人会认为它们的新家就是它们本来应该在的地方:在 HTML 标题中,与与页面相关的所有其他“元数据”一起。


GOV.UK 上的 HTML 标题中显示的 API 链接
在我们构建自定义工具时,我们尝试确保它们也通过 API 提供有用的内容。因此,对于我们的“计划者”工具(产假/陪产假),数据可以导出为 iCal 或 JSON。如果您仔细查看 URL,您将能够弄清楚如何获取任何日期的数据。同样,我们所有的“日历”数据(例如银行假日)都以 iCal 和 JSON 格式提供。

我们认为这是一个非常好的开始,我们自己也在使用这些 API 来整合网站并对其进行测试。我们尚未准备好承诺的是,这是这些 API 的最终形式。我们在govuk-api.heroku.com上整合了一个快速“API 浏览器”(效仿Flickr、卫报和其他网站的示例)。

看到一些人已经在使用这些 API,真是令人兴奋:Harry Metcalfe 使用它来探索网站上的词频,Luke Vincent为该网站构建了自己的搜索界面,Saul Cozens 构建了一个 WordPress 插件,用于在博客中嵌入 GOV.UK 内容。

和我们所做的一切一样,我们的 API 也在不断迭代,并且处于测试阶段。我们意识到,目前它们是获取内容的合理方式,但我们需要特别注意它们如何与智能答案等工具配合使用。