简介
本模块介绍使用自定义连接器策略并说明如何使用策略模板进行配置。
在本模块中,您将会:
发现如何通过策略在运行时修改自定义连接器的行为。
将策略模板应用于自定义连接器。
策略允许您在运行时修改自定义连接器的行为。 您可以使用策略执行数据转换、传递请求、设置参数值等操作。 您可在导入前直接在自定义连接器 API 属性文件中配置策略,也可以通过自定义连接器设计器中的制作者门户应用策略模板进行配置。
常见的策略使用案例有:
设置主机 URL - 默认情况下,主机 URL 将硬编码到连接器配置中。 策略与连接参数结合使用,允许您每次使用连接器创建连接时指定主机 URL。 例如,本使用案例可以处理系统 API 的开发、测试和生产版本。
设置标头 - 用于将请求的连接参数、查询或正文的数据提升到标头。 本流程一般用于适应需要在标头中配置特定信息的 API。 例如,本使用案例可能是相关 ID,用于跟踪正在执行的完整业务流程。
设置查询参数 - 如果开发者未进行配置,在必要时可使用它处理默认值。 例如,如果 API 需要顶部参数来指示使用策略返回多少条记录,则如果开发者未进行配置,则您可以设置需要使用的默认值。
您可以使用策略来处理特定的 API 需求,并通过隐藏不必要的复杂性来简化连接器的使用。
应用策略
通过将策略模板应用于自定义连接器,您可以从模板列表中选择要使用的策略。 每个选定的模板都会提示您填写该策略所需的配置。 填写完表单后,可通过更新连接器来激活策略。 以下屏幕截图显示了使用其中一个模板创建新策略的示例。
在应用策略模板时,您可以选择将其应用于所有操作和触发器,还是仅应用于特定操作和触发器。
例如,设置主机 URL 模板通常应用于所有操作和触发器。 反之,将数组转换为对象(预览版)模板可能仅应用于返回相似数据的一两个操作。
配置策略以对所有操作和触发器运行时,您需要确保策略参数中使用的任何数据路径对所有操作和触发器都有效,否则,您将遇到运行时错误。
在配置的策略列表中,您可以选择每个策略旁边的省略号 (...),然后在列表中向上或向下移动它。 利用本功能,您可以配置在运行时应用策略的顺序,如果您要使用多个策略模板完成数据转换,则该功能很有帮助。 例如,一个策略可以将分隔的字符串分析为数组,另一个策略可以将数组转换为对象。 在本示例中,实现顺序非常重要。
配置策略模板会导致对连接器的 API 属性进行修改。 API 属性与连接器的 API 定义分开存储。 您可以通过门户导入更新后的 API 定义,而无需覆盖已配置的策略。
使用 CLI 进行查看和修改
除了在门户中查看策略之外,您还可以使用来自 CLI 的 paconn download 命令,将策略作为 API 属性文件的一部分导出。
下载内容包括四个文件(apiDefintion.swagger.json、apiProperties.json、icon.png、settings.json)。
如果您打开 apiProperties.json 文件并查找 PolicyTemplateInstances 部分,将会看到所有已配置的策略。
以下屏幕截图显示了 policyTemplateInstances 部分的示例。
如果您熟悉 JSON,也可以直接修改 apiProperties.json 文件。 对于某些策略,例如设置主机 URL,如果要在创建连接时收到 URL 提示,则您必须修改 apiPropertiess.json 文件中的 connectionParameters 才能完成策略配置。 Paconn update 命令可用于导入更改。
考虑其他连接器如何使用策略时,这可能会有用。 Microsoft Power Platform 连接器 GitHub 存储库有许多经过认证和未经认证的连接器的典型示例,可供您参考。 此外,您还可以浏览并查看连接器的 apiProperties.json 文件。 通过使用策略模板名称(如 setHeader)搜索存储库,还可以快速显示哪些连接器正在使用该策略。