使用本指南开始使用 Extensibility Toolkit 构建 Microsoft Fabric 工作负载。 设置环境、在 GitHub Codespaces 或本地运行 Starter-Kit,并了解生成和发布所需的基础知识。
你所构建的
在 Fabric 中运行 Starter-Kit ,浏览其清单和主机 API 使用情况,进行少量 UI 更改,并了解工作负载创建的项目的行为方式(如本机 Fabric 项目)。
先决条件
- 访问 Fabric 租户和工作区,以便可以在其中创建项目
- GitHub 帐户(Codespaces 必需)
- 如果在本地开发:最近的 Node.js LTS 和包管理器(请参阅自述文件以获取确切工具)
- 创建Microsoft Entra 应用程序的访问权限
- 可选:如果计划在 Azure 中托管 Web 应用,则为 Azure 订阅
小窍门
本地开发在 Windows、macOS 和 Linux 上均获得原生支持。 在运行安装脚本或启动开发服务器之前,请查看并满足 Starter-Kit 中的先决条件。
注释
无需将任何内容部署到租户即可试用 初学者工具包。 在开发过程中使用 DevGateway 来模拟 Fabric 主机。
重要
确保你有权访问 Fabric 工作区,并且租户允许开发人员功能。 在测试之前启用 Fabric 开发人员模式。
选择路径
若要快速开始,请选择以下选项之一来访问代码:
选项 1:在 GitHub Codespaces 中启动
- 将 Starter-Kit 存储库 分叉到 GitHub 帐户。
- 在分支上创建 GitHub Codespace,以开始使用基于云的开发环境。
有关 GitHub Codespaces 的详细信息,请参阅 GitHub Codespaces 文档。
选项 2:克隆并在本地运行
- 将 Starter-Kit 存储库 分叉到 GitHub 帐户。
- 将分支克隆到本地计算机:
git clone https://github.com/<your-account>/fabric-extensibility-toolkit.git
cd fabric-extensibility-toolkit
- 安装本地开发所需的先决条件:
所需工具:
- Node.js LTS: 下载 Node.js
- PowerShell 7 (macOS/Linux 上的 pwsh): 安装 PowerShell
- .NET SDK (macOS 建议使用 x64 版本):下载 .NET
- VS Code 或类似编辑器: 下载 VS Code
- Azure CLI (仅用于创建 Microsoft Entra 应用): 安装 Azure CLI
AI 辅助开发
此存储库与 AI 结对编程工具配合良好。 无论是在本地开发还是在 GitHub Codespaces 中开发,都可以使用 GitHub Copilot 或其他 AI 助手来加速编辑 React 组件、更新路由或生成测试基架等任务。
小窍门
Starter-Kit 存储库已启用 AI,并包括 GitHub Copilot 的使用说明,指导你根据需求调整 Hello World 项目。 其他 AI 工具(例如,人类 Claude)可以遵循相同的指导,但必须配置为读取存储库的指导文件或文档。
- 使用 AI 来起草项目编辑器/视图组件,然后适应 Starter-Kit 中使用的主机 API 模式。
- 要求 AI 汇总工作负荷清单并建议最小权限集。
- 在 Codespaces 中,Copilot 在浏览器或 VS Code 桌面版中可用;使开发服务器保持运行状态,以便立即查看更改。
小窍门
如果你有兴趣查看其他人生成的内容,请打开 扩展性示例 并将其部署到你的环境。 可在此处找到有助于入门的丰富项类型。
最佳做法
- 派生存储库:派生Starter-Kit存储库,并将您的派生作为项目的基础。
- 保持同步:保持你的代码分叉与上游同步,以获取改进。
- 维护项目结构一致性:保留 Starter-Kit 的项目结构和组织模式,以确保与将来的更新兼容并保持代码清晰。
- 常规 Starter-Kit 集成:定期将 Starter-Kit 中的代码更改集成到项目中,以受益于 bug 修复、新功能和安全更新。 设置一个过程,定期查看和合并上游更改(每月或季度)。
- 提前验证清单:提前验证工作负荷清单并遵循最低特权权限。
- 使用开发容器:使用开发容器或 Codespaces 创建一致且可弃用的环境。
- 使用提供的脚本:使用提供的脚本(Setup、StartDevServer、StartDevGateway)自动执行设置和每日工作流。
后续步骤
访问代码(在 Codespaces 中或本地)后,请继续阅读 详细设置指南 ,获取有关以下作的分步说明:
- 运行安装脚本
- 启动开发环境
- 启用 Fabric 开发人员功能
- 测试你的第一个 HelloWorld 项目
- 编码入门
- AI 辅助开发提示
- 排查常见问题
其他资源
- 了解 体系结构 以及主机、应用和 Fabric 服务如何交互
- 阅读架构和最佳做法的清单概述
- 了解 工作负荷清单 结构和配置
- 使用 DevGateway 进行开发和本地测试
- 准备好广泛共享工作负荷时发布工作负荷