Consulta los conectores compatibles con Application Integration.

Cómo ver la especificación de OpenAPI de tu integración

Application Integration permite generar y ver de forma dinámica las especificaciones de OpenAPI de tus integraciones publicadas que están configuradas con uno o más activadores de API. Acceder a la especificación de OpenAPI de tu integración te permite hacer lo siguiente:

• Obtén una comprensión integral de los extremos de la API, los métodos y las estructuras de datos de tu integración.
• Proporciona una vista detallada y centralizada de la API de tu integración para permitir un desarrollo y una solución de problemas más eficientes.
• Expón tus APIs de integración y realiza integraciones sin problemas con agentes conversacionales. Consulta Cómo compilar agentes conversacionales con Application Integration.

¿Qué es la especificación de OpenAPI?

La especificación de OpenAPI (OAS) es un formato estándar independiente del lenguaje para describir las APIs de RESTful. La especificación de OpenAPI, que suele escribirse en formatos YAML o JSON, presenta una descripción formal de los elementos de la API, como su URL base, las rutas y verbos, los encabezados, los parámetros de consulta, los tipos de contenido, los modelos de solicitud y respuesta, y mucho más. Para obtener más información sobre la Especificación de OpenAPI, consulta Especificación de OpenAPI.

Genera y visualiza la especificación de OpenAPI

Puedes generar y ver de forma dinámica la especificación de OpenAPI para tus integraciones desde el editor de integraciones en la consola de Google Cloud o con una llamada a la API.

Antes de comenzar

• Confirma que tu integración esté configurada con uno o más activadores de API. Para obtener información sobre cómo configurar activadores de API, consulta Activadores de API.
• Publica tu integración. Para obtener información sobre cómo publicar una integración, consulta Prueba y publica integraciones.

Ver la especificación de OpenAPI

Para ver la especificación de OpenAPI de tu integración, selecciona una de las siguientes opciones:

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"
          

Información sobre la especificación de OpenAPI

Application Integration genera la especificación de OpenAPI para tus integraciones publicadas según el estándar de la especificación de OpenAPI 3.0. En la siguiente tabla, se describen los elementos de la especificación de OpenAPI que se generan en Application Integration:

Consideraciones

Se aplican las siguientes consideraciones cuando visualizas la especificación de OpenAPI de tu integración:

• La especificación de OpenAPI solo se genera para las integraciones publicadas.
• La especificación de OpenAPI solo se genera para las integraciones configuradas con uno o más activadores de API.
• La especificación de OpenAPI solo se genera para las integraciones en la misma región.
• De forma predeterminada, la especificación de OpenAPI se genera en formato YAML. Para generar y ver la especificación de OpenAPI en formato JSON, establece el parámetro fileFormat en JSON en la llamada a la API.
• Actualmente, Application Integration solo admite el siguiente conjunto limitado de palabras clave del esquema JSON:
  • type
  • items
  • properties
  • description
  • required
  • array
  • object
  • oneOf
  • allOf
  • anyOf
  • not
  • null
  • enum
  • additionalProperties
  • default
• Cuando valides la especificación de OpenAPI con el editor de Swagger, es posible que encuentres errores semánticos relacionados con las rutas de la API, similares a los de la siguiente imagen:

  

  Estos errores se pueden ignorar sin problemas. La especificación de OpenAPI sigue siendo válida.

¿Qué sigue?

• Crea agentes conversacionales con la Integración de aplicaciones.
• Obtén más información sobre los activadores de API.
• Obtén más información sobre cómo probar y publicar integraciones.