练习 - 使用 CLI 下载连接器

6 分钟

本练习要求您使用 CLI 下载连接器、验证定义并解决问题。您可通过本练习模拟如何为创建和认证开放源代码自定义连接器做好准备。

本练习要求安装 Python 并访问用于本练习的计算机上的命令提示。

重要提示

使用已预配 Microsoft Dataverse 的测试环境。如果没有本环境，您可以注册社区计划。

注意

将以下文件下载到本地计算机来完成本练习 Contoso Invoicing 触发器。选择屏幕中部右侧的下载按钮。

任务 1：导入解决方案

在本任务中，您将导入包含 Contoso Invoicing 自定义连接器的非托管解决方案。您将使用本连接器完成本练习中的任务。

转到 Power Apps Maker Portal 并确保您处于正确的环境中。
选择解决方案 > 导入解决方案。
选择浏览。
先选择 ContosoInvoicingOpenSource_1_0_0_0.zip 解决方案，然后选择打开。
选择下一步。
选择导入，然后等待导入完成。您应在导入完成后收到成功消息。
打开您导入的 Contoso Invoicing - Open Source 解决方案。

这时应该会看到 Contoso Invoicing - Open Source 自定义连接器组件。

任务 2：安装 Microsoft Power Platform CLI

Microsoft Power PlatformCLI 包括旨在辅助 Microsoft Power Platform 自定义连接器开发的 paconn 命令行工具。 Paconn 工具会使用 Python 运行时，您也需要安装。

转到下载 Python 并选择下载 Python。您可以使用任意高于 3.5 的版本。
选择下载的 .exe 文件开始安装。
选中添加 Python xx 到路径复选框，选择立即安装，然后等待安装完成。
安装完成后关闭安装向导。
启动命令提示，然后运行以下命令安装 paconn。

pip install paconn
等待安装完成。

任务 3：在本地下载连接器

本任务要求您在本地下载连接器定义文件，以添加“主机 URL”属性。

运行登录命令。

paconn login
复制提供的代码。
在浏览器中，使用与环境相同的凭据登录。转到 Microsoft 设备登录，粘贴复制的代码并选择下一步。
提供您的凭据。
选择继续。

您应收到成功登录的消息。
返回命令提示，此处应会显示登录成功消息。
运行下载命令。

paconn download
系统提示选择环境时，输入您安装解决方案的环境的编号，然后按 Enter 键。
提供 Contoso Invoicing - Open Source 连接器的编号，然后按 Enter 键。
下载应成功完成。请注意连接器的下载位置。

任务 4：验证

本任务要求您验证连接器并修复一些常见错误。此外，您还要添加所需连接器的元数据。

复制连接器的下载路径。
使用您所复制的路径外加 API 定义 Swagger 文件名 \apiDefinition.swagger.json 来运行验证命令。

paconn validate --api-def [Path to apiDefinition.swagger.json]
您应该会收到 ListInvoices 操作的第四个参数缺少摘要和缺少联系人属性的错误。
修复缺少摘要的问题。转到 Power Apps Maker Portal 并确保您处于正确的环境中。
选择解决方案并打开 Contoso Invoicing - Open Source 解决方案。
先选择 Contoso Invoicing - Open Source 连接器，然后选择编辑。
选择定义选项卡，然后选择 ListInvoices 操作。
向下滚动至请求部分，先选择 toAmount 参数的省略号（V 形）按钮，然后选择编辑。
在摘要字段输入目标金额，然后选择更新连接器。
等待连接器更新完成。
删除之前下载的连接器（稍后还会重新添加）。从计算机上删除您所下载的连接器。
再次下载连接器。返回命令提示，并重新运行下载命令。

paconn download
当系统提示选择环境时，输入您安装解决方案的环境的编号，然后按 Enter 键。
提供 Contoso Invoicing - Open Source 连接器的编号，然后按 Enter 键。
下载应成功完成。请注意连接器的下载位置。
使用您所复制的路径外加 API 定义 Swagger 文件名 \apiDefinition.swagger.json 来运行验证命令。

paconn validate --api-def [Path to apiDefinition.swagger.json]
您现在只会收到一个缺少联系人参数的错误。
转到您所下载的连接器文件夹，使用所选文本编辑器（如 Notepad）打开 apiDefinition.swagger.json 文件。

在描述属性之后的信息中添加联系人属性。

"contact": {
  "name": "Contoso Support",
  "url": "https://contosoinvoicingtest.azurewebsites.net",
  "email": "info@Contoso.com"
}

在信息后添加连接器元数据。

"x-ms-connector-metadata": [
  {
   "propertyName": "Website",
   "propertyValue": "https://contosoinvoicingtest.azurewebsites.net"
  },
  {
   "propertyName": "Privacy policy",
   "propertyValue": "https://contosoinvoicingtest.azurewebsites.net"
  },
  {
   "propertyName": "Categories",
   "propertyValue": "Productivity"
  }
],

选择文件并保存您的更改。
再次运行验证命令。

paconn validate --api-def [Path to apiDefinition.swagger.json]
连接器现在应能够通过验证。

您已成功准备好连接器，可以将其创建为开放源代码并进行认证。如果您构建的是真实的连接器，则可以将相应连接器发布至 GitHub。

练习 - 使用 CLI 下载连接器

任务 1：导入解决方案

任务 2：安装 Microsoft Power Platform CLI

任务 3：在本地下载连接器

任务 4：验证

反馈