Créer un connecteur personnalisé et une connexion
Cette page explique 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 la page Spécifications 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 3.0 à l'aide du convertisseur Swagger.
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é
- Dans la console, accédez à la page Integration Connectors > Custom connectors (Connecteurs d'intégration > Connecteurs personnalisés), puis sélectionnez ou créez un projet Google Cloud .
- Cliquez sur Créer pour ouvrir la page Créer un connecteur personnalisé.
- Dans la section Détails du connecteur, spécifiez les champs obligatoires, tels que Nom du connecteur et Nom à afficher.Saisissez également les cas d'utilisation du connecteur dans le champ Description.
- 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.
- Compte de service: sélectionnez un compte de service disposant des rôles requis.
- Logo: importez une image dans un bucket Cloud Storage pour l'utiliser comme logo du connecteur.
- Dans la section Connector Specification (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.
- Dans la section Destination du connecteur, ajoutez l'adresse IP du rattachement de point de terminaison et le port sur lequel le service s'exécute.
- Dans la section Connector Authentication (Authentification du connecteur), sélectionnez No Authentication (Aucune authentification). Les types d'authentification ne sont pas compatibles avec les connecteurs de place de marché.
- Dans la section Variables de backend, ajoutez les variables que vous souhaitez utiliser comme entrée lors de la création de la connexion. Ces variables s'affichent sur la page de création de la connexion et sont envoyées à chaque appel d'API effectué au service. Les valeurs qui ne changeront pas avec les API, telles que les identifiants de backend tiers, doivent être ajoutées dans cette section.
- 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.
- Dans la console Cloud, accédez à la page Integration Connectors > Connections (Connecteurs d'intégration > Connexions), puis sélectionnez ou créez un projet Google Cloud.
- Cliquez sur Créer pour ouvrir la page Créer une connexion.
- Sélectionnez le connecteur personnalisé que vous avez créé.
- Ajoutez des valeurs pour les champs de connexion que vous avez définis.
- Créez la connexion.
Valider le service
Pour valider le service, créez une intégration.
- Dans la console Google Cloud, accédez à la page Application Integration (Intégration d'applications), puis créez une intégration.
- Ajoutez le déclencheur d'API et la tâche de connecteur.
- Configurez la tâche de connecteur pour qu'elle utilise la connexion créée à l'étape précédente. Ajoutez Data Mapper si nécessaire.
- Configurez la valeur connectorInputPayload du connecteur conformément au schéma.
- Exécutez l'intégration pour vérifier que la connexion fonctionne.
Si l'intégration s'exécute correctement et renvoie la réponse attendue, le service Web est validé.
Étape suivante
- Découvrez comment créer un script de démarrage pour le service Web.