# OpenAPI连接器 您可以创建一个自定义的OpenAPI连接器，支持通过OpenAPI标准的文件（支持json与yaml格式）导入，OpenAPI版本目前支持2.0与3.0。 Open API连接器支持多种鉴权模式，多种连接类型，支持自定义配置动作和动作参数。 #### 创建OpenAPI连接器 1. 登录[CodeArts Link控制台](https://console.huaweicloud.com/codearts-link/)。 2. 在左侧导航栏选择"连接器"，在连接器页面单击"自定义连接"页签。 3. 单击"新建连接器"，弹出"新建OpenAPI连接器"弹窗。 4. 选择导入文件。 表1导入文件说明 | 参数 | 说明 | |:---|:---| | 选择一个OpenAPI标准的文件 | - 选择OpenAPI标准版本，可选择2.0或3.0。 - 单击"下载模板"可下载对应版本的OpenAPI标准模板文件。 - 根据业务需求修改模板文件并上传文件。 | | 鉴权类型 | 选择连接器创建连接时，所需的认证类型。认证类型从OpenAPI规范中的安全方式中提取。 此处以导入3.0版本模板文件为例，可选如下鉴权类型。 - api_key：API KEY认证。当选择API KEY鉴权类型时，支持编辑鉴权参数。 - x-bfs-iam-token：IAM用户Token认证。 - x-bfs-iam-aksk：IAM用户AK/SK认证。 - Basic：Basic认证。 - 无认证：无认证。 | | 动作 | 选择需要配置的动作，动作将从OpenAPI规范中的API中提取。生成连接器后，可以添加触发器。 | 5. 配置基本信息。 表2基本信息说明 | 参数 | 说明 | |:---|:---| | 图标 | 自定义连接器的图标。 单击"上传图标"，可从本地上传一个图标。不上传则默认使用根据连接器名称首字母生成的标准图标。 | | 连接器名称 | 填写连接器的名称。 | | 标签 | 填写连接器的标签。 | | 类别 | 选择连接器的类别。 - HTTP - 数据库 - 华为云服务 - SaaS应用 - 邮箱 - 其他 - 消息系统 | | 描述 | 填写连接器的描述信息，用于识别不同的连接器。 | 6. 单击"创建并配置详情"，进入连接器的动作配置页面。 7. 单击![](https://support.huaweicloud.com/usermanual-codeartslink/zh-cn_image_0000001692046889.png "点击放大")，在"新建动作"弹窗中配置动作信息，并单击"确定"。 表3新建动作说明 | 参数 | 说明 | |:---|:---| | 动作名 | 填写动作名称。 | | 类型 | 选择动作类型。 - GET - POST - PUT - DELETE | | 路径 | 填写路径，例如"/history"。 | | 描述 | 输入动作描述。 | 8. 新增动作完成后，配置动作参数。 表4动作参数说明 | 参数 | 说明 | |:---|:---| | 输入参数 | 配置输入参数，可配置"Query"、"Header"两种类型的输入参数。 - 参数名：输入参数名。 - 参数展示名：输入参数展示名。 - 类型：选择参数类型，可选择"string"、"integer"、"number"。 - 是否必填：配置此参数是否为必填参数。 - 描述：输入参数描述。 单击"操作"栏下的![](https://support.huaweicloud.com/usermanual-codeartslink/zh-cn_image_0000001691967609.png)，可以新增参数。 | | 请求体 | 配置请求体参数。当动作类型配置为"POST"、"PUT"、"DELETE"时，需要配置请求体参数。 - 参数名：输入参数名。 - 参数展示名：输入参数展示名。 - 类型：选择参数类型，可选择"object"、"string"、"integer"、"number"。 - 是否必填：配置此参数是否为必填参数。 - 描述：输入参数描述。 单击"操作"栏下的![](https://support.huaweicloud.com/usermanual-codeartslink/zh-cn_image_0000001643767104.png)，可以新增参数。 说明： 第一个参数的参数名默认为"根节点"，参数类型默认为"object"，均不支持修改。 | | 返回值 | 配置返回值参数。在"返回值"栏下单击![](https://support.huaweicloud.com/usermanual-codeartslink/zh-cn_image_0000001643607848.png)后在下拉框可以新增不同的返回值。 - 参数名：输入参数名。 - 参数展示名：输入参数展示名。 - 类型：选择参数类型，可选择"object"、"array"、"string"、"integer"。 - 是否必填：配置此参数是否为必填参数。 - 描述：输入参数描述。 单击"操作"栏下的![](https://support.huaweicloud.com/usermanual-codeartslink/zh-cn_image_0000001643607844.png)，可以新增参数。 说明： 第一个参数的参数名默认为"根节点"，参数类型默认为"object"，均不支持修改。 | 9. 单击"保存"，完成OpenAPI连接器的创建。 #### 创建OpenAPI连接 1. 登录[CodeArts Link控制台](https://console.huaweicloud.com/codearts-link/)。 2. 在左侧导航栏选择"连接器"，在连接器页面单击"自定义连接"页签。 3. 单击一个OpenAPI连接器的"新建连接"。 4. 在"新建连接"弹窗中配置信息。 表5新建连接参数说明（Basic鉴权） | 参数 | 说明 | |:---|:---| | 连接名称 | 输入连接名称。 | | url地址 | 输入连接地址。 | | 用户名 | 输入用户名。 | | 密码 | 输入密码。 | | 描述 | 输入描述信息。 | ![](https://support.huaweicloud.com/usermanual-codeartslink/public_sys-resources/note_3.0-zh-cn.png) 此处以OpenAPI连接器选择"Basic"鉴权类型为例，当OpenAPI连接器选择其它鉴权类型，那么在新建连接时，则配置对应的鉴权参数。 如果自定义连接器为无鉴权方式，则无需新增连接。 5. 单击"确定"，完成创建OpenAPI连接。