创建自定义连接器和连接

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

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

为 Web 服务创建 OpenAPI 规范

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

您还可以使用 gin swagger 中间件自动生成 OpenAPI 2.0 规范。如需了解相关信息，请参阅 Gin Swagger。您必须使用 Swagger Converter 将 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. 在控制台中，前往 Application Integration > 自定义连接器 页面， 然后选择或创建 Google Cloud 项目。

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

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

创建连接

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

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

验证服务

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

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

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

后续步骤