Creare un connettore personalizzato e una connessione

Questa pagina descrive come creare una specifica OpenAPI per un servizio web e poi creare un connettore personalizzato e una connessione per questo connettore.

Prima di creare un connettore personalizzato, devi creare una specifica OpenAPI per il servizio web.

Creare una specifica OpenAPI per il servizio web

I connettori personalizzati supportano OpenAPI 3.0. Puoi anche creare manualmente la specifica. Per informazioni sulle specifiche OpenAPI, consulta Specifiche OpenAPI.

Puoi anche generare automaticamente la specifica OpenAPI 2.0 utilizzando il middleware gin swagger. Per informazioni, consulta Gin Swagger. Devi convertire la specifica OpenAPI 2.0 in una specifica OpenAPI v3.0 utilizzando Swagger Converter.

Esempio di specifica 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"
          }
        }
      }
    }
  }
}

Creare un connettore personalizzato e convalidare il servizio

Devi creare un connettore personalizzato e poi convalidare il servizio web utilizzandolo in una connessione in Application Integration.

Prima di iniziare

Configura Private Service Connect (PSC) per questa macchina virtuale e poi crea un collegamento endpoint.

Creare un connettore personalizzato

  1. Nella console, vai alla pagina Integration Connectors > Custom connectors (Connettori di integrazione > Connettori personalizzati) e poi seleziona o crea un Google Cloud progetto.

    Vai alla pagina Connettori personalizzati

  2. Fai clic su Create new (Crea nuovo) per aprire la pagina Create custom connector (Crea connettore personalizzato).
  3. Nella sezione Connector details (Dettagli connettore), specifica i campi obbligatori, come Connector name (Nome connettore) e Display name (Nome visualizzato). Inoltre, inserisci i casi d'uso del connettore nel campo Description (Descrizione).
  4. Configure connector destination for backend access (Configura la destinazione del connettore per l'accesso al backend): attiva questa opzione. Vengono visualizzate le sezioni di configurazione aggiuntive nella pagina.
  5. Service account (Account di servizio): seleziona un account di servizio con i ruoli richiesti.
  6. Logo: carica un'immagine in un bucket Cloud Storage per utilizzarla come logo del connettore.
  7. Nella sezione Connector Specification (Specifica connettore), inserisci l'URL pubblico della specifica OpenAPI o carica il file di specifica in un bucket Cloud Storage.
  8. Nella sezione Connector Destination (Destinazione connettore), aggiungi l'indirizzo IP del collegamento endpoint e la porta su cui è in esecuzione il servizio.
  9. Nella sezione Connector Authentication (Autenticazione connettore), seleziona No Authentication (Nessuna autenticazione). I tipi di autenticazione non sono supportati per i connettori Marketplace.
  10. Nella sezione Backend Variables (Variabili di backend), aggiungi le variabili che vuoi utilizzare come input durante la creazione della connessione. Queste variabili vengono visualizzate nella pagina di creazione della connessione e vengono inviate a ogni chiamata API effettuata al servizio. I valori che non cambieranno con le API, come le credenziali di backend di terze parti, devono essere aggiunti in questa sezione.
  11. Crea il connettore personalizzato. Assicurati di aver specificato un logo e di aver descritto i casi d'uso del connettore personalizzato.

Creare una connessione

Dopo aver creato il connettore personalizzato, crea la connessione per questo connettore.

  1. Nella console Cloud, vai alla pagina Integration Connectors > Connections (Connettori di integrazione > Connessioni) e poi seleziona o crea un progetto Google Cloud.

    Vai alla pagina Connessioni

  2. Fai clic su Create new (Crea nuovo) per aprire la pagina Create connection (Crea connessione).
  3. Seleziona il connettore personalizzato che hai creato.
  4. Aggiungi i valori per i campi di connessione che hai definito.
  5. Crea la connessione.

Convalidare il servizio

Per convalidare il servizio, crea una nuova integrazione.

  1. Nella Google Cloudconsole, vai alla pagina Application Integration (Integrazione applicazioni) e poi crea un'integrazione.
  2. Aggiungi il trigger API e l'attività del connettore.
  3. Configura l'attività del connettore in modo che utilizzi la connessione creata nel passaggio precedente. Se necessario, aggiungi Data Mapper.
  4. Configura connectorInputPayload per il connettore in base allo schema.
  5. Esegui l'integrazione per verificare che la connessione funzioni.

Se l'integrazione viene eseguita correttamente e restituisce la risposta prevista, il servizio web viene convalidato.

Passaggi successivi