使用英语阅读

通过


Microsoft Learn 目录 API 常见问题解答

本文列出了有关 Microsoft Learn 目录 API 的常见问题及其答案,以及可能需要的指向更多信息的链接。

常规

问:使用 Learn 目录 API 需要多少费用?

可免费使用 Learn 目录 API。 有关详细信息,请参阅 Learn 目录 API 功能概述一文的“可用性和定价”部分。

问:有哪些 Learn 目录 API 使用规则?

请参阅 Microsoft LearnMicrosoft API 使用条款

问:是否需要载入或获取密钥才能使用 Learn 目录 API?

否。 API 是公开可用的。 请参阅通过 cURL 和 Visual Studio Code 开始使用 Learn 目录 API一文和/或 Learn 目录 API 开发人员参考一文。

问:此 API 是否会使用户在我们的平台内使用 Learn 内容?

没有。 Learn 目录 API 提供有关内容的元数据,以及指向内容的直接链接。 用户可以根据 Microsoft API 使用条款将这些链接集成到任何学习管理系统 (LMS) 或 Web 体验中。

问:从 Learn 目录 API 返回的数据是保持静态还是变化?

只要添加、修改或删除新内容,数据就会更改,这通常是每天一次。

API 响应

问:是否可以一次获取所有数据?

是的。 使用基本终结点 learn.microsoft.com/api/catalog 可获取完整响应。 有关更多 API 请求信息,请参阅 Learn 目录 API 开发人员参考一文。

问:是否可以预筛选响应?

是的。 请参阅 Learn 目录 API 开发人员参考一文中提供的查询筛选器。

问:每个内容对象的 UID 是否唯一?

是的。 UID 代表“唯一 ID”,对于每个内容对象都是唯一的。 如果 UID 发生更改,即使标题或其他元数据保持不变,内容也会被视为新对象。

问:为什么模块的摘要中有 HTML 标记?

我们通常会尽量保持摘要的原始格式,但有时我们需要强调或链接某些文本。

问:为什么没有单个单元的链接?

单元不作为独立的内容写入。 它们旨在以特定的顺序用于模块。 出于此原因,我们会包括指向模块详细信息页和第一个单元的链接,使用户可从该位置开始,继续浏览内容。

问:如何判断哪些内容是新的?

last_modified 值指示上次修改记录的时间。

问:是否为内容链接启用了单一登录 (SSO)?

目前没有。 我们的目标是在将来启用 SSO。

内容

问:UID 对于内容来说是否唯一?

是的。 UID 代表“唯一 ID”,对于每个内容对象都是唯一的。 如果 UID 发生更改,即使标题或其他元数据保持不变,内容也会被视为新对象。

问:所有模块都是学习路径的一部分吗?

没有。 模块都能够独立存在,从某种意义上说,它们在其中端到端地教授方案或概念,并且不需要学习先决条件模块。 对于某些模块,就是这样,它们不是学习路径的一部分。 对于其他模块,它们会被捆绑在一个或多个学习路径中,引导用户生成更高级的概念。 模块不一定是某一个学习路径的一部分,它也可以是一个或多个学习路径的一部分。

问:如何知道对内容执行了添加、刷新或删除操作?

添加新内容对象时,它们会在响应中显示为新对象(由 UID 标识)。 内容被修改时,可以根据其 last_modified 值进行判断。 删除内容后,将从响应中删除内容对象。 尽管 API 响应中更新的内容有时稍有延迟,但当用户关注内容的 URL 时,他们始终会看到最新的信息。 当内容被删除后,旧 URL 将重定向到新内容或体验,或重定向到下一个最佳选项。

值得注意的是,内容一直都在更新。 我们每天发布两次可用更新。 它们可能是次要更新(例如次要文本更改),也可能是主要更新,例如主要修订、新增或删除。 通常,内容组合作为一个涵盖数千个参与者的高度治理的大型开源项目进行管理,因此,更改会一直发生。 如果在生产系统中使用 Learn 目录 API,则应注意这一点,并让系统具备相应的处理能力。

问:我点击了书签中的内容链接,但它现在显示的内容与我预期的内容不同。 为什么?

我们努力确保没有人通过我们网站的链接进入死胡同 (404)。 当内容被修改或替换后,我们将实施旧链接的重定向,该重定向会自动将你带到新内容。 如果由于各种原因,内容被弃用而未被替换,我们将重定向到下一个最合适的内容(可能是一个稍微修改过的范围)或一个登录页,等等。

问:如何实现访问文档、视频和代码示例目录?

目前没有编程方法可用于访问这些目录。 我们的目标是在将来支持以编程方式访问这些目录。

本地化

问:Microsoft Learn 中提供了哪些语言?

Microsoft Learn 中提供了超过 65 个区域设置。 你可以通过网站页脚在此处查看完整列表(选择要使用的语言以查看完整列表)。

问:是否可以采用其他语言提供内容?

视情况而定。 我们的目标是以内容中教授的产品所支持的所有语言提供内容。 当学习者以给定区域设置访问 Microsoft Learn 网站时,如果不存在该区域设置的内容,则用户会看到所需区域设置的页眉和页脚,并且在本地化版本可用之前,核心内容默认为英语。

问:对于给定的内容对象,内容是否会因所使用的语言不同而有所差异?

有可能。 将更新发布到英语内容时,本地化管道会尽快更新本地化版本 - 通常是在原始更改后的几天内。

其他

问:是否存在用于获取查阅量、单击量和完成情况等数据的报告 API 或功能?

目前没有报告 API。 我们确实有组织报告功能,此功能允许组织报告其用户的完成情况。

后续步骤

访问以下链接可以了解有关 Learn 目录 API 的详细信息: