宣布推出 REST API 体验更新

本文由 docs.microsoft.com 团队项目经理 Jessie Huang 撰写。

今天,我们很高兴在 docs.microsoft.com 上推出两项关键的 REST 体验改进:

  • REST API 浏览器的预览版本 - 一种搜索和发现 Microsoft 开发的 REST API 的简便方法。
  • REST 试用 - 一种使你能够直接在喜欢的 Web 浏览器中尝试 REST API 的交互式体验。

在一个位置发现 REST API

如果你已经熟悉了我们现有的任何 API 浏览器体验,例如适用于 .NETPowerShellPythonJavaScript 的体验,这个新版本将让你感觉很舒服 - 通过她,你可快速获取各种 REST API 的相关文档,而无需依赖不那么集中的搜索体验。 API 浏览器就是通过在几秒中找到正确的 API,让你实现自己的目标。

以前,如果你想要在 docs.microsoft.com 上查找特定的 REST API 文档,你可能必须通过网站范围搜索来查找它,或者使用内容页上的任何导航组件(例如目录)。 这可能很费时间,尤其是在你确切知道要查找什么内容时。 我们想让它变得更简单。

从现在开始,你可从一个集中位置 https://docs.microsoft.com/rest/api 更有效地发现 Microsoft REST API。 只需从下拉列表中选择服务即可查找所有可用的服务 API:

通过选择产品来发现 REST API

是否需要保存单击? 对于一些最常用的 API,你可始终依赖于快速筛选器 - 单击一个筛选器将立即调出给定服务适合其最新版本的全套 API:

通过页面内的快速筛选器来发现 REST API

通过我们设计的搜索体验,无论你是否知道确切的关键字,甚至即使你不知道它所在的服务,也能找到必需的 API 信息! 默认情况下,我们将搜索 docs.microsoft.com 上记录的所有 API。 仅当选择了服务时,才会在该服务的范围内进行搜索。

通过一个关键字搜索 REST API

需要同时搜索多个关键字? 这也可以做到!

通过多个关键字搜索 REST API

在浏览器中试用 Azure REST API

找到了一个感兴趣的 Azure API,但不知道它是否能帮助你构建你的场景? 不用担心,因为现在开始,你可在 docs.microsoft.com 上的浏览器中直接试用 Azure REST API!

只需按绿色的“试用”按钮即可:

REST 试用 - 启动体验

为 REST API 选择“试用”后,你将转到一个聚焦视图,让你使用不同的参数值或请求正文进行试验。 你可使用页面左上角的“内容”汉堡菜单轻松更改文章上下文:

REST 试用 - 更改文章上下文

我们期待你的反馈

我们计划在近期内实现多项改进,因此这个体验绝不是最终体验,例如我们将不止对 Azure REST API 启用“试用”功能。 我们希望你能告诉我们应如何改进 REST 体验 - 你只需发起一个新问题,我们会尽快给你答复。

你也可以关注我们的 Twitter 帐户,获取最新更新和通知!

梦想让开发人员的工作更轻松? 加入我们的团队吧