工具和 SDK
使用工具、SDK 和库生成和开发 Microsoft Teams 应用。 现在,Microsoft提供了一个全面的平台,用于无缝创建、开发、测试、调试和发布 Teams 应用,使整个过程高效且简化。 Teams 提供以下平台:
工具
Teams 平台提供不同的工具来生成和开发 Teams 应用。 以下工具可用于生成应用:
工具 | 为什么需要? | 环境 | 测试和调试 |
---|---|---|---|
Teams 工具包 | 借助 Teams 工具包,可以轻松开始使用 Teams 应用开发。 可以从为组织生成的常见自定义应用的项目模板开始, (LOB 应用) 方案,也可以从示例开始。 使用 Visual Studio Code 和 Visual Studio 通过自动应用注册和配置来节省设置时间。 |
Visual Studio Code:JavaScript 和 TypeScript Visual Studio:.NET 和 Blazor |
在 Visual Studio Code 和 Visual Studio 中 |
Teams 的 Yeoman 生成器 | Yeoman 生成器或 YoTeams 允许你在首选编辑器中使用 TypeScript 和 JavaScript 创建 Teams 应用,而无需任何外部或联机依赖项。 | TypeScript 和 JavaScript | 不适用 |
Teams 工具包 CLI | TeamsFx CLI 是基于文本的命令行界面, (CLI) ,可加速 Teams 应用程序开发。 它旨在在生成 Teams 应用程序时提供以键盘为中心的体验。 | JavaScript 和 .NET | 使用命令提示符 |
Teams 开发人员门户 | Teams 开发人员门户是用于配置、分发和管理 Teams 应用的主要工具。 使用开发人员门户,可以创建基本应用清单 (以前称为 Teams 应用清单) 并将应用分发到 Teams。 | 支持所有语言 | Teams 开发人员门户 |
有关使用 Teams 工具包和 Yeoman Teams 项目生成 Teams 应用的详细信息。
Teams 工具包 | Yeoman Teams 项目 | |
---|---|---|
环境变量 | 使用 .env 文件 |
使用 .env 文件 |
生成清单 | Teams 工具包在创建项目时自动生成。 | gulp 清单 |
部署 Teams 应用 | 自动更新 use 命令 Teams: Update Teams App |
gulp 租户:部署 |
创建 Microsoft Entra 应用 | 调试或预配项目时自动创建。 用户还可以通过在文件中填写 Teams 应用 ID .env 来使用其现有 Microsoft Entra 应用。 |
手动 |
添加 SSO | 提供启用 SSO 的示例和操作指南以添加 SSO。 | 手动 |
机器人或消息扩展注册 | 调试或预配项目时自动创建。 用户还可以指定自己的机器人 ID。 | 手动 (Azure 机器人) |
公开 Node.js 应用 | 选项卡:localhost + HTTPS 和其他:开发隧道 | gulp ngrok-serve |
运行 Node.js 应用 | npm 运行 teamsfx:dev | gulp serve |
一键调试 | 在 Visual Studio Code 和 Visual Studio 中进行 F5 或调试 | 不适用 |
SDK 和库
Teams 平台提供不同的 SDK、库和 API 来生成和开发 Teams 应用。
以程图说明了不同的 SDK、库及其关系:
需要另一个库来生成应用的库。 项目会自动拉取到另一个库中。
将引用传递给另一个库的应用的库。
库通常与另一个库一起使用,但没有正式的依赖项。
基础服务或 API 的库。
Teams 开发人员平台 SDK & 库
SDK 和库 | 为什么需要? | 相关 SDK 和库 |
---|---|---|
TeamsFx SDK | TeamsFx 使用 Teams 单一登录 (SSO) 并将云资源访问为零配置的单行语句,从而简化任务。 |
取决于 Bot Framework SDK、 Teams JavaScript 客户端库和 Microsoft Graph SDK。
可以将其与 Teams AI 库 和 自适应卡片一起使用。 |
Teams JavaScript 客户端库 | 使用 Teams JavaScript 客户端库 (TeamsJS) ,可以在 Teams、Microsoft 365 应用和 Outlook 中创建托管体验。 这些体验涉及在 iFrame 中托管应用内容。 |
可以将引用传递给 SharePoint 框架 (SPFx) 。
可以将其与 Microsoft Graph SDK、 自适应卡片和 Fluent UI React 组件一起使用。 |
SharePoint 框架 (SPFx) | SharePoint 框架 (SPFx) 提供了一个页面和 Web 部件模型,该模型完全支持客户端 SharePoint 开发,与 SharePoint 数据无缝集成,并扩展Microsoft Teams 和 Microsoft Viva。 |
可以将其与 Microsoft Graph SDK、 自适应卡片和 Fluent UI React 组件配合使用。
基于 SharePoint REST API。 |
实时共享 SDK | Live Share 是一种 SDK,旨在将 Teams 应用转换为协作式多用户体验,而无需编写专用后端代码。 |
可以将其与 Microsoft Graph SDK、 自适应卡片和 Fluent UI React 组件配合使用。
可以将引用传递给 Teams JavaScript 客户端库。 |
用于生成 Teams 应用的核心 SDK 和库
SDK 和库 | 为什么需要? | 相关 SDK 和库 |
---|---|---|
Bot Framework SDK | Microsoft Bot Framework 和 Azure AI 机器人服务是库、工具和服务的集合,可用于生成、测试、部署和管理智能机器人。 Bot Framework 包括一个模块化且可扩展的 SDK,用于构建机器人和连接到 AI 服务。 | 基于 Azure 机器人服务。 |
Microsoft Graph SDK | Microsoft Graph SDK 旨在简化访问 Microsoft Graph 的高质量、高效且可复原的应用程序的创建。 SDK 包括两个组件,例如服务库和核心库。 | 基于 Microsoft Graph。 |
Teams AI 库 | Teams AI 库是一个以 Teams 为中心的界面,用于访问基于 GPT 的公共语言模型和用户意向引擎。 这减少了处理复杂且昂贵的任务(编写和维护聊天机器人逻辑),以便与大型语言模型 (LLM) 集成的要求。 |
取决于 Bot Framework SDK。
基于 Azure OpenAI。 |
用于生成 Teams 应用的其他库和 UI 实用工具
SDK 和库 | 为什么需要? | 相关 SDK 和库 |
---|---|---|
自适应卡片 | 自适应卡片是一种可自定义的卡片,可以包含文本、语音、图像、按钮和输入字段的任意组合。 | 可以将其与 TeamsFx SDK、 Teams JavaScript 客户端库和 SharePoint Framework (SPFx) 配合使用。 |
Fluent UI React 组件 | Fluent UI React 组件是 UI 元素和工具的集合,这些元素和工具来自组合生产中使用的各种基于 React 的组件库,例如 @fluentui/react 和 @fluentui/react-northstar 。 |
可以将它与 Teams JavaScript 客户端库 和 SharePoint Framework (SPFx) 配合使用。 |
Fluid Framework | Fluid Framework 由有助于分发和同步共享状态的客户端库组成。 这些库使多个客户端能够使用类似于处理本地数据的编码模式同时创建和操作共享数据结构。 |
可以将引用传递给 Live Share SDK。
基于 Azure Fluid Relay。 |
Microsoft Entra ID 保护的服务和 API
SDK 和库 | 为什么需要? | 相关 SDK 和库 |
---|---|---|
Azure 机器人服务 | Azure 机器人服务是库、工具和服务的集合,可用于生成、测试、部署和管理智能机器人。 | 用于 Bot Framework SDK。 |
Azure OpenAI | Azure OpenAI 服务提供对 OpenAI 的强大语言模型的 REST API 访问,包括 GPT-3、Codex 和 Embeddings 模型系列。 此外,新的 GPT-4 和 ChatGPT (gpt-35-turbo) 模型系列现在以预览版提供。 这些模型可以适应你的特定任务,包括但不限于内容生成、摘要、语义搜索和自然语言到代码翻译。 | 用于 Teams AI 库。 |
Microsoft Graph | Microsoft Graph 是 Microsoft 365 中通往数据和智能的网关。 它提供统一的可编程模型,可用于访问 Microsoft 365、Windows 10 和企业移动性 + 安全性中的海量数据。 利用 Microsoft Graph 中的大量数据针对与数百万名用户交互的组织和客户构建应用。 | 用于 Microsoft Graph SDK。 |
SharePoint REST API | 可以使用任何支持代表性状态传输的技术远程处理 SharePoint 数据, (REST) Web 请求。 您可以使用 SharePoint 提供的 REST 接口执行基本的创建、读取、更新和删除 (CRUD) 操作。 | 用于 SharePoint 框架 (SPFx) 。 |
Azure Fluid Relay | Fluid Framework 是一个独立于平台的开源框架。 Azure Fluid Relay 是 Fluid Framework 的托管服务,可帮助开发人员构建实时协作体验,并跨连接的 JavaScript 客户端实时复制状态。 | 用于 Fluid Framework。 |
建议
工具 | 详细信息 |
---|---|
Teams 工具包 | 建议使用 Teams 工具包 v5 生成应用,因为 Teams 工具包 v4 仅在功能有限的情况下可用。 |
Teams 工具包 CLI | 建议使用 Teams 工具包 CLI v3 生成 Teams 应用,因为 TeamsFx CLI v1 和 TeamsFx CLI v2 仅在功能有限的情况下可用。 |