Consultez les connecteurs compatibles avec Application Integration.

Afficher la spécification OpenAPI pour votre intégration

Application Integration vous permet de générer et d'afficher de manière dynamique les spécifications OpenAPI de vos intégrations publiées et configurées avec un ou plusieurs déclencheurs d'API. Accéder à la spécification OpenAPI de votre intégration vous permet de :

• Comprenez en détail les points de terminaison, les méthodes et les structures de données de l'API de votre intégration.
• Développez et dépannnez plus efficacement en obtenant une vue détaillée et centralisée de l'API de votre intégration.
• Exposez vos API d'intégration et intégrez-les facilement aux agents conversationnels. Pour en savoir plus, consultez Créer des agents conversationnels avec Application Integration.

Qu'est-ce que la spécification OpenAPI ?

La spécification OpenAPI (OAS) est un format standard et indépendant du langage permettant de décrire les API RESTful. Généralement rédigée au format YAML ou JSON, la spécification OpenAPI présente une description formelle des éléments de l'API, tels que son URL de base, ses chemins et verbes, ses en-têtes, ses paramètres de requête, ses types de contenu, ses modèles de requête et de réponse, et plus encore. Pour en savoir plus sur la spécification OpenAPI, consultez Spécification OpenAPI.

Générer et afficher la spécification OpenAPI

Vous pouvez générer et afficher de manière dynamique la spécification OpenAPI de vos intégrations à partir de l'éditeur d'intégration dans la console Google Cloud ou à l'aide d'un appel d'API.

Avant de commencer

• Vérifiez que votre intégration est configurée avec un ou plusieurs déclencheurs d'API. Pour en savoir plus sur la configuration des déclencheurs d'API, consultez Déclencheurs d'API.
• Publiez votre intégration. Pour savoir comment publier une intégration, consultez Tester et publier des intégrations.

Afficher la spécification OpenAPI

Pour afficher la spécification OpenAPI de votre intégration, sélectionnez l'une des options suivantes :

curl -X POST \
    -H "authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json" \
    -d '{
    "apiTriggerResources": [{
    "integrationResource": "INTEGRATION_NAME",
    "triggerId": ["api_trigger/TRIGGER_NAME", "api_trigger/TRIGGER_NAME_2", "api_trigger/TRIGGER_NAME_n"]
    },
    {
    "integrationResource": "INTEGRATION_NAME",
      "triggerId": ["api_trigger/TRIGGER_NAME"]
    }],
    "fileFormat": "DOC_TYPE"
    }' \
    "https://LOCATION-integrations.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION:generateOpenApiSpec"
          

Comprendre la spécification OpenAPI

Application Integration génère la spécification OpenAPI pour vos intégrations publiées en suivant la norme OpenAPI Specification 3.0. Le tableau suivant décrit les éléments de la spécification OpenAPI générés dans Application Integration :

Remarques

Les considérations suivantes s'appliquent lorsque vous consultez la spécification OpenAPI de votre intégration :

• La spécification OpenAPI n'est générée que pour les intégrations publiées.
• La spécification OpenAPI n'est générée que pour les intégrations configurées avec un ou plusieurs déclencheurs d'API.
• La spécification OpenAPI n'est générée que pour les intégrations dans la même région.
• La spécification OpenAPI est générée au format YAML par défaut. Pour générer et afficher la spécification OpenAPI au format JSON, définissez le paramètre fileFormat sur JSON dans l'appel d'API.
• L'Application Integration n'est actuellement compatible qu'avec l'ensemble limité de mots clés de schéma JSON suivants :
  • type
  • items
  • properties
  • description
  • required
  • array
  • object
  • oneOf
  • allOf
  • anyOf
  • not
  • null
  • enum
  • additionalProperties
  • default
• Lorsque vous validez la spécification OpenAPI à l'aide de Swagger Editor, vous pouvez rencontrer des erreurs sémantiques liées aux chemins d'accès de l'API, comme illustré dans l'image suivante :

  

  Vous pouvez ignorer ces erreurs sans problème. La spécification OpenAPI est toujours valide.

Étapes suivantes

• Créez des agents conversationnels avec Application Integration.
• En savoir plus sur les déclencheurs d'API
• En savoir plus sur Tester et publier des intégrations