创建自定义连接器和连接

本页介绍了如何为 Web 服务创建 OpenAPI 规范，然后为此连接器创建自定义连接器和连接。

在创建自定义连接器之前，您必须为该 Web 服务创建 OpenAPI 规范。

为 Web 服务创建 OpenAPI 规范

自定义连接器支持 OpenAPI 3.0。您也可以手动创建规范。如需了解 OpenAPI 规范，请参阅 OpenAPI 规范。

您还可以使用 gin swagger 中间件自动生成 OpenAPI 2.0 规范。如需了解详情，请参阅 Gin Swagger。您必须使用 Swagger 转换器将 OpenAPI 2.0 规范转换为 OpenAPI v3.0 规范。

OpenAPI 规范示例。

{
  "openapi": "3.0.0",
  "info": {
    "title": "Go HTTPbin Proxy Service",
    "description": "A simple Go service that proxies requests to httpbin.org, adding custom headers.",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "http://localhost:8080"
    }
  ],
  "paths": {
    "/getData": {
      "get": {
        "summary": "Fetch data from httpbin.org/get",
        "description": "Sends a GET request to httpbin.org/get, including any custom headers.",
        "responses": {
          "200": {
            "description": "Successful response from httpbin.org",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        }
      }
    },
    "/postData/{id}": {
      "post": {
        "summary": "Post data to httpbin.org/post",
        "description": "Sends a POST request to httpbin.org/post with data, including any custom headers.",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string"   

                  },
                  "address": {
                    "type": "string"
                  },
                  "gender": {
                    "type": "string"   
                  }
                },
                "required": [
                  "name",
                  "address",
                  "gender"
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response from httpbin.org",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request - Invalid request body"
          }
        }
      }
    }
  }
}

创建自定义连接器并验证服务

您必须创建自定义连接器，然后在 Application Integration 中的连接中使用该连接器来验证 Web 服务。

准备工作

为此虚拟机设置 Private Service Connect (PSC)，然后创建端点附件。

创建自定义连接器

  1. 在 Cloud 控制台中，依次前往 Integration Connectors > Custom connectors 页面，然后选择或创建一个 Google Cloud 项目。

    前往“自定义连接器”页面

  2. 点击新建，打开创建自定义连接器页面。
  3. 在连接器详情部分，指定必填字段，例如连接器名称和显示名称。此外，在说明字段中输入连接器的用例。
  4. 为后端访问配置连接器目标位置：启用此选项。这会在页面中显示其他配置部分。
  5. 服务账号：选择具有所需角色的服务账号。
  6. 徽标：将图片上传到 Cloud Storage 存储桶，以用作连接器徽标。
  7. 在 Connector Specification（连接器规范）部分，输入您的开放 API 规范的公开网址，或将规范文件上传到 Cloud Storage 存储桶。
  8. 在 Connector Destination 部分中，添加端点附件的 IP 地址和服务运行的端口。
  9. 在连接器身份验证部分中，选择无身份验证。购物平台连接器不支持身份验证类型。
  10. 在后端变量部分中，添加您要在创建连接时用作输入的变量。这些变量会显示在连接创建页面中，并会在向服务发出每次 API 调用时发送。此部分必须添加不会随 API 而更改的值，例如第三方后端凭据。
  11. 创建自定义连接器。确保您已指定徽标并说明了自定义连接器的用例。

创建连接

创建自定义连接器后，请为此连接器创建连接。

  1. 在 Cloud 控制台 中，进入 Integration Connectors > 连接页面，然后选择或创建一个 Google Cloud 项目。

    转到“连接”页面

  2. 点击新建以打开创建连接页面。
  3. 选择您创建的自定义连接器。
  4. 为您定义的连接字段添加值。
  5. 创建连接。

验证服务

如需验证服务，请创建新的集成。

  1. 在 Google Cloud控制台中，前往应用集成页面，然后创建集成。
  2. 添加 API 触发器和连接器任务。
  3. 将连接器任务配置为使用上一步中创建的连接。根据需要添加数据映射器。
  4. 根据架构为连接器设置 connectorInputPayload。
  5. 运行集成以验证连接是否有效。

如果集成成功运行并返回预期响应，则表示网络服务已通过验证。

后续步骤