Créer un connecteur personnalisé et une connexion

Sur cette page, nous expliquons comment créer une spécification OpenAPI pour un service Web, puis un connecteur personnalisé et une connexion pour ce connecteur.

Avant de créer un connecteur personnalisé, vous devez créer une spécification OpenAPI pour le service Web.

Créer une spécification OpenAPI pour le service Web

Les connecteurs personnalisés sont compatibles avec OpenAPI 3.0. Vous pouvez également créer la spécification manuellement. Pour en savoir plus sur les spécifications OpenAPI, consultez OpenAPI Specification (Spécification OpenAPI).

Vous pouvez également générer automatiquement la spécification OpenAPI 2.0 à l'aide du middleware gin swagger. Pour en savoir plus, consultez gin-swagger. Vous devez convertir la spécification OpenAPI 2.0 en spécification OpenAPI v3.0 à l'aide de Swagger Converter.

Exemple de spécification 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"
          }
        }
      }
    }
  }
}

Créer un connecteur personnalisé et valider le service

Vous devez créer un connecteur personnalisé, puis valider le service Web en l'utilisant dans une connexion dans Application Integration.

Avant de commencer

Configurez Private Service Connect (PSC) pour cette machine virtuelle, puis créez un rattachement de point de terminaison.

Créer un connecteur personnalisé

  1. Dans la console, accédez à la page Connecteurs d'intégration > Connecteurs personnalisés, puis sélectionnez ou créez un projet Google Cloud .

    Accéder à la page "Connecteurs personnalisés"

  2. Cliquez sur Créer pour ouvrir la page Créer un connecteur personnalisé.
  3. Dans la section Informations sur le connecteur, indiquez les champs obligatoires, tels que Nom du connecteur et Nom à afficher. Saisissez également les cas d'utilisation du connecteur dans le champ Description.
  4. Configurer la destination du connecteur pour l'accès au backend : activez cette option. Les sections de configuration supplémentaires s'affichent sur la page.
  5. Compte de service : sélectionnez un compte de service disposant des rôles requis.
  6. Logo : importez une image dans un bucket Cloud Storage pour l'utiliser comme logo du connecteur.
  7. Dans la section Spécification du connecteur, saisissez l'URL publique de votre spécification OpenAPI ou importez votre fichier de spécification dans un bucket Cloud Storage.
  8. Dans la section Destination du connecteur, ajoutez l'adresse IP du rattachement de point de terminaison et le port sur lequel le service est exécuté.
  9. Dans la section Authentification du connecteur, sélectionnez Aucune authentification. Les types d'authentification ne sont pas compatibles avec les connecteurs Marketplace.
  10. Dans la section Variables de backend, ajoutez les variables que vous souhaitez utiliser comme entrées lorsque vous créerez la connexion. Ces variables apparaissent sur la page de création de la connexion et sont envoyées à chaque appel d'API effectué sur le service. Les valeurs qui ne changeront pas avec les API, telles que les identifiants de backend tiers, doivent être ajoutées dans cette section.
  11. Créez le connecteur personnalisé. Assurez-vous d'avoir spécifié un logo et décrit les cas d'utilisation du connecteur personnalisé.

Créer une connexion

Après avoir créé le connecteur personnalisé, créez la connexion pour ce connecteur.

  1. Dans la console Cloud, accédez à la page Connecteurs d'intégration > Connexions, puis sélectionnez ou créez un projet Google Cloud.

    Accéder à la page "Connexions"

  2. Cliquez sur Créer pour ouvrir la page Créer une connexion.
  3. Sélectionnez le connecteur personnalisé que vous avez créé.
  4. Ajoutez des valeurs pour les champs de connexion que vous avez définis.
  5. Créez la connexion.

Valider le service

Pour valider le service, créez une intégration.

  1. Dans la console Google Cloud, accédez à la page Application Integration, puis créez une intégration.
  2. Ajoutez le déclencheur d'API et la tâche "Connecteurs".
  3. Configurez la tâche "Connecteurs" pour qu'elle utilise la connexion créée à l'étape précédente. Ajoutez Data Mapper si nécessaire.
  4. Configurez connectorInputPayload pour le connecteur conformément au schéma.
  5. Exécutez l'intégration pour vérifier que la connexion fonctionne.

Si l'intégration aboutit et renvoie la réponse attendue, le service Web est validé.

Étape suivante