SuperAPI AI 工具集

using-backstage-identity

通用与其它

查看项目

更新于 10-16 02:27

技能介绍

用途:当 Backstage 前端插件需要当前登录用户的信息时使用本技能,包括用户的实体引用(如 user:default/jdoe)、个人资料(显示名、邮箱、头像)、用于筛选“我拥有的内容”的归属实体引用,以及以当前用户身份调用后端 API 所需的 Backstage 令牌。

主要能力:提供选择正确模式的指引。获取当前用户(实体引用、归属引用、个人资料)使用 useApi(identityApiRef).getBackstageIdentity() / getProfileInfo(),参考 references/current-user.md。

两种调用模式:独立模式(开发中途)——用户正在编辑已有插件,阅读参考文档并把模式应用到需要它的组件;脚手架后模式(由 creating-backstage-plugin 调用)——把模式应用到刚生成的插件,参考文档的“Post-scaffold usage”部分会指明要编辑的文件和插入内容。

常见注意事项:在 NFS 插件中 identityApiRef 从 @backstage/frontend-plugin-api 导入(同一引用也从 @backstage/core-plugin-api 为兼容旧版重新导出,新插件应始终使用 NFS 包);getBackstageIdentity() 是异步的,返回 BackstageUserIdentity,需从中解构 userEntityRef 和 ownershipEntityRefs;不要把结果存到顶层变量,应在 hook 内调用(如 React 组件内或 useAsync 回调中),以便身份变化时重新执行。

UI 约定:尽量使用 @backstage/ui 渲染(Skeleton、Alert、Text、Flex、Button 等),完整组件目录与样式指引见 using-backstage-ui 技能。

限制:资料未提供具体版本要求、安装命令、收费或平台信息。