Skip to main content

实用 API

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

概览​

实用程序编程接口(Utility API)是独立功能的一部分，是插件可以请求使用的接口。 它们由 TypeScript 接口以及用于访问其实现的引用("API ref")定义。 插件和核心框架都可以提供实用程序编程接口，其本身也是扩展可以在应用程序配置中进行输入、替换和声明式配置。

实用 API 的一个常见例子是与插件后端部分(如目录客户端)交互的客户端接口。 然后，任何前端插件都可以请求该接口的实现，通过它来发出请求。

下图显示了一个假设的应用程序，它依赖于两个插件，同时还提供了一些额外的覆盖。 请注意，插件和核心框架都提供了实用 API，而且它们相互依赖。 该应用程序还选择使用覆盖机制来提供一个 API 的替代实现，它优先于默认实现。 因此，该 API 的所有用户都将确保获得提供给他们的新实现。

frontend system utility apis diagram

扩展结构​

所有实用程序编程接口都执行createApiExtension.factoryDataRef输出数据类型，并且必须专门附加到core扩展的apis这些默认设置是由createApiExtension框架功能。

由于实用程序应用编程接口是一种扩展，因此也可以在高级用例中使用，这对于复杂的程序应用编程接口来说偶尔会很有用，因为采用者可以利用额外的编程功能对其进行扩展。

链接​

  • 插件文档中的[实用程序编程接口]部分(../utility-apis/01-index.md) * 关于[实用程序编程接口]的传统文档(../../api/utility-apis.md)