根据 API 定义构建连接器

新建连接器

如果选择 从 API 定义开始，则必须提供 API 定义：
- 从本地文件 – 上传 Postman 或 Swagger 集合。
- 来自 URL – 输入文件 URL，例如https://petstore.swagger.io/v2/swagger.json 。
单击“继续”。

在“确认导入”窗口中，您可以执行以下操作：
- 更改“提供程序名称”、“应用程序名称” 和“连接器名称”。
- 修改要在自定义连接器中使用的资源。系统将自动选择所有可用资源，并取消选择要排除的对象。
  - 使用“搜索”栏查找特定资源。
- 单击“创建”。
现在会显示“设置”窗口。
在“信息”选项卡中，您可以配置以下字段：
- “连接器前缀”– 例如 documentation。该前缀反映在您的连接器密钥中。
- “提供程序名称”– 输入提供程序名称。
- “应用程序名称”– 输入应用程序名称。
- “API 类型”– 默认情况下此字段为禁用状态，因为当前仅支持 REST。
- 显示名称 – 这是连接器的名称，因为它将显示在“连接器”目录中。
- “说明”– 输入连接器的说明。
- 图标 – 单击“浏览”以从您的计算机上传图像。
目录预览显示自定义连接器在集成服务连接器目录中的显示方式。
单击“保存”。

在“基本 API ”选项卡中，配置应用程序 API 和分页的基本 URL：

基本 URL – 自动填充在创建连接器时声明的值。
“分页类型” – 下拉列表中的可用选项包括：“从 1 开始的页面”、“从 0 开始的页面”、“偏移量”、“自定义”。如果供应商文档未提供有关分页的任何详细信息，请保留默认值。
最大分页值 – 默认值为 100 。如果供应商文档未提供有关分页的任何详细信息，请保留默认值。
“内容类型”标头 – 默认情况下禁用此字段，因为当前仅支持 application/json 。
接受标头 – 默认情况下禁用此字段，因为当前仅支持 application/json 。

在“身份验证” 选项卡中，配置连接器的身份验证类型。有关支持的选项的更多信息，请参阅身份验证类型。

完成身份验证配置后，从下拉菜单中选择“添加连接”：

如果连接成功，状态将更新为“已连接”。

连接器生成器会根据提供的 API 定义生成资源列表。左侧菜单显示按组组织的可用资源列表。

单击“更多选项”按钮菜单以进一步配置每种方法。您可以：
- 添加方法 – 打开“创建新资源”窗口。
- “允许方法删除” – 为组中的每个资源激活“删除”图标。
- 编辑路径 – 编辑资源的路径。例如： [BASE URL]/pet = https://petstore.swagger.io/v2/pet
- “删除” – 删除资源组。系统将显示一条消息，警告您无法撤销该操作。
- “复制” – 打开“复制资源”窗口，您可以在其中编辑路径，选择显示名称和选择方法。
您还可以通过两种方式 创建新的资源组 ：
- 从空白开始
- 从 cURL
如果您选择从空白开始配置新资源，请配置以下字段：
- 路径 - [Base URL]/[path]
- 显示名称
- 选择方法：“获取”、“按 ID 获取”、“发布”、“放置”、“补丁”、“删除”
如果您选择从 cURL 配置新资源，请输入 cURL 命令。

选择资源时，将显示以下窗口：

根据您选择的资源方法，以下配置选项卡可用：参数、响应/请求字段、分页、搜索。

例如，所有四个选项卡都可用于 GET 方法。对于 POST 方法，您只能看到“参数” 、“请求字段” 和“响应字段” 选项卡。

在参数中，您可以查看所选资源的可用参数列表，添加新参数或从现有资源导入参数。

此表中列出的参数是使用自定义连接器构建自动化时将在 Studio 中使用的参数。

Pet 对象对应于 Pet 资源组，可用字段是为 GETBYID 资源设置的字段：

发送请求时，系统会自动生成每个资源的“响应” 和“请求” 字段。

在每个相应的选项卡中，您可以编辑或删除任何字段。如果单击“编辑”图标，则会显示以下配置窗口：

在“响应/请求字段” 选项卡中，还提供以下选项：

其他选项 按钮：

选项	操作
更新响应根键	在处理响应中的嵌套数组时定义响应键。
删除方法的所有字段	删除所选方法的所有字段。
从有效负载生成	使用服务文档中的有效负载示例或 API 调用来生成资源字段。