Crie um conector personalizado e uma ligação

Esta página descreve como criar uma especificação OpenAPI para um serviço Web e, em seguida, criar um conetor personalizado e uma ligação para este conetor.

Antes de criar um conector personalizado, tem de criar uma especificação OpenAPI para o serviço Web.

Crie uma especificação OpenAPI para o serviço Web

Os conetores personalizados suportam a OpenAPI 3.0. Também pode criar manualmente a especificação. Para informações sobre as especificações da OpenAPI, consulte o artigo Especificações da OpenAPI.

Também pode gerar automaticamente a especificação OpenAPI 2.0 através do middleware gin swagger. Para mais informações, consulte Gin Swagger. Tem de converter a especificação OpenAPI 2.0 na especificação OpenAPI v3.0 através do Swagger Converter.

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

Crie um conetor personalizado e valide o serviço

Tem de criar um conector personalizado e, em seguida, validar o serviço Web usando-o numa ligação na integração de aplicações.

Antes de começar

Configure o Private Service Connect (PSC) para esta máquina virtual e, em seguida, crie uma associação de ponto final.

Crie um conector personalizado

  1. Na Console, aceda à página Integration Connectors > Conetores personalizados e, de seguida, selecione ou crie um Google Cloud projeto.

    Aceda à página Conetores personalizados

  2. Clique em Criar novo para abrir a página Criar conetor personalizado.
  3. Na secção Detalhes do conetor, especifique os campos obrigatórios, como Nome do conetor e Nome a apresentar.Além disso, introduza os exemplos de utilização do conetor no campo Descrição.
  4. Configurar destino do conetor para acesso de back-end: ative esta opção. Isto mostra as secções de configuração adicionais na página.
  5. Conta de serviço: selecione uma conta de serviço que tenha as funções necessárias.
  6. Logótipo: carregue uma imagem para um contentor do Cloud Storage para a usar como logótipo do conector.
  7. Na secção Especificação do conetor, introduza o URL público da especificação da API aberta ou carregue o ficheiro de especificação para um contentor do Cloud Storage.
  8. Na secção Destino do conector, adicione o endereço IP da associação do ponto final e a porta na qual o serviço está a ser executado.
  9. Na secção Autenticação do conetor, selecione Sem autenticação. Os tipos de autenticação não são suportados para os conetores do Marketplace.
  10. Na secção Variáveis de back-end, adicione as variáveis que quer usar como entrada ao criar a associação. Estas variáveis aparecem na página de criação da associação e são enviadas em todas as chamadas API feitas ao serviço. Os valores que não vão mudar com as APIs, como as credenciais de back-end de terceiros, têm de ser adicionados nesta secção.
  11. Crie o conector personalizado. Certifique-se de que especificou um logótipo e descreveu os exemplos de utilização do conetor personalizado.

Crie uma associação

Depois de criar o conetor personalizado, crie a ligação para este conetor.

  1. Na Cloud Console, aceda à página Integration Connectors > Ligações e, de seguida, selecione ou crie um projeto do Google Cloud.

    Aceda à página Ligações

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

Valide o serviço

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

  1. Na Google Cloud consola, aceda à página Integração de aplicações e, de seguida, crie uma integração.
  2. Adicione o acionador de API e a tarefa do conetor.
  3. Configure a tarefa do conetor para usar a associação criada no passo anterior. Adicione o mapeador de dados, se necessário.
  4. Configure o connectorInputPayload para o conetor de acordo com o esquema.
  5. Execute a integração para verificar se a ligação está a funcionar.

Se a integração for executada com êxito e devolver a resposta esperada, o serviço Web é validado.

O que se segue?