实用 API

**注意：新的前台系统处于alpha阶段，只有少数插件支持。

如所述在架构部分在此情况下，实用 API 是共享功能的一部分，即插件可以请求使用的接口。 它们由 TypeScript 接口以及用于访问其实现的引用("API ref")定义。 插件和核心框架都可以提供这些 API，它们本身也是扩展可以接受输入，也可以在应用程序配置中进行声明式配置，还可以完全用履行相同合约的自定义实现来替代。

创建实用程序接口

详情请参阅 正文。

Backstage 应用程序、插件和核心 Backstage 框架都可以公开实用 API，以供一般使用。

有些是开箱即用的，例如用于读取应用程序配置的 API；有些是由第三方插件提供的，例如目录客户端 API，目录本身和你自己的代码都可以利用它与目录后端对话；有些是你自己创建的，并在你的 Backstage 实例中提供，供你的私人插件生态系统使用。

正文描述了创建和公开自己的实用程序编程接口(utility API)的过程，以便在插件和应用程序之间共享功能或可配置性。

使用实用程序接口

详情请参阅 正文。

一旦创建了实用程序编程接口，就可以通过几种方式访问和使用它们。

一些实用程序编程接口反过来又依赖于其他实用程序编程接口。 这种强大的可组合性让您可以利用已经编写好的可重用组件。 特别是，您可能希望依赖于 React 框架提供的应用程序编程接口，例如用于读取应用程序配置和许多其他用例。 有时，您会在 React 组件中请求实用程序编程接口，例如用于访问 i18n 字符串或发出分析事件。

详细介绍见正文

配置实用程序接口

详情请参阅主文章。

大多数实用程序编程接口无需任何配置即可直接使用。 但它们是适当的扩展，因此可以完全由您的应用程序替换其实现，以用于高级用例。 它们还可以在应用程序配置中进行配置，或通过输入来扩展其功能。

这些案例都在正文.

从旧的前台系统迁移过来

如果你想了解如何将自己的实用程序接口从旧前台系统迁移到新系统，可参阅专门的迁移指南.