Criar um conector e uma conexão personalizados

Esta página descreve como criar uma especificação da OpenAPI para um serviço da Web e, em seguida, um conector personalizado e uma conexão para esse conector.

Antes de criar um conector personalizado, você precisa criar uma especificação OpenAPI para o serviço da Web.

Criar uma especificação OpenAPI para o serviço da Web

Os conectores personalizados são compatíveis com o OpenAPI 3.0. Também é possível criar a especificação manualmente. Para informações sobre as especificações da OpenAPI, consulte Especificações da OpenAPI.

Também é possível gerar automaticamente a especificação OpenAPI 2.0 usando o middleware gin swagger. Para mais informações, consulte Swagger do Gin. É necessário converter a especificação OpenAPI 2.0 para a especificação OpenAPI v3.0 usando o Swagger Converter.

Exemplo de especificação 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"
          }
        }
      }
    }
  }
}

Criar um conector personalizado e validar o serviço

É necessário criar um conector personalizado e validar o serviço da Web usando-o em uma conexão na Application Integration.

Antes de começar

Configure o Private Service Connect (PSC) para essa máquina virtual e crie um anexo de endpoint.

Criar um conector personalizado

  1. No Console, acesse a página Integration Connectors > Custom connectors, selecione ou crie um projeto do Google Cloud .

    Acessar a página "Conectores personalizados"

  2. Clique em Criar novo para abrir a página Criar conector personalizado.
  3. Na seção Detalhes do conector, especifique os campos obrigatórios, como Nome do conector e Nome de exibição.Além disso, insira os casos de uso do conector no campo Descrição.
  4. Configurar o destino do conector para acesso ao back-end: ative essa opção. Isso mostra as outras seções de configuração na página.
  5. Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
  6. Logotipo: faça upload de uma imagem em um bucket do Cloud Storage para usá-la como o logotipo do conector.
  7. Na seção Especificação do conector, insira o URL público da especificação da API aberta ou faça upload do arquivo de especificação para um bucket do Cloud Storage.
  8. Na seção Destino do conector, adicione o endereço IP do anexo do endpoint e a porta em que o serviço está em execução.
  9. Na seção Autenticação do conector, selecione Sem autenticação. Os tipos de autenticação não são compatíveis com os conectores do Marketplace.
  10. Na seção Variáveis de back-end, adicione as variáveis que você quer usar como entrada ao criar a conexão. Essas variáveis aparecem na página de criação de conexão e são enviadas em cada chamada de API feita para o serviço. Os valores que não vão mudar com as APIs, como as credenciais de back-end de terceiros, precisam ser adicionados nesta seção.
  11. Crie o conector personalizado. Verifique se você especificou um logotipo e descreveu os casos de uso do conector personalizado.

Crie uma conexão

Depois de criar o conector personalizado, crie a conexão dele.

  1. No console do Cloud, acesse a página Integration Connectors > Conexões e selecione ou crie um projeto do Google Cloud.

    Acessar a página "Conexões"

  2. Clique em Criar novo para abrir a página Criar conexão.
  3. Selecione o conector personalizado que você criou.
  4. Adicione valores para os campos de conexão que você definiu.
  5. Crie a conexão.

Validar o serviço

Para validar o serviço, crie uma nova integração.

  1. No console do Google Cloud, acesse a página Integração de aplicativos e crie uma integração.
  2. Adicione o acionador da API e a tarefa do conector.
  3. Configure a tarefa do conector para usar a conexão criada na etapa anterior. Adicione o Data Mapper, se necessário.
  4. Configure o connectorInputPayload para o conector de acordo com o esquema.
  5. Execute a integração para verificar se a conexão está funcionando.

Se a integração for executada e retornar a resposta esperada, o serviço da Web será validado.

A seguir