Consulta los conectores compatibles con Application Integration.

Ver la especificación de OpenAPI de tu integración

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

• Obtenga información detallada sobre los endpoints, los métodos y las estructuras de datos de la API de su integración.
• Permite un desarrollo y una solución de problemas más eficientes proporcionando una vista detallada y centralizada de la API de tu integración.
• Expón tus APIs de integración e intégralas perfectamente con agentes conversacionales. Consulta el artículo Crear 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 APIs RESTful. La especificación de OpenAPI, que se suele escribir en formato YAML o JSON, presenta una descripción formal de los elementos de la API, como su URL base, rutas y verbos, encabezados, parámetros de consulta, tipos de contenido, modelos de solicitud y respuesta, etc. Para obtener más información sobre la especificación de OpenAPI, consulta Especificación de OpenAPI.

Generar y ver la especificación de OpenAPI

Puedes generar y ver dinámicamente la especificación de OpenAPI de tus integraciones desde el editor de integraciones de la Google Cloud consola o mediante una llamada a la API.

Antes de empezar

• Confirme que su integración esté configurada con uno o varios 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 Probar y publicar integraciones.

Ver especificación de OpenAPI

Para ver la especificación de OpenAPI de tu integración, selecciona una de las 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 de las integraciones publicadas siguiendo 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 generada en Application Integration:

Cuestiones importantes

Debes tener en cuenta lo siguiente al consultar 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 varios activadores de API.
• La especificación de OpenAPI solo se genera para las integraciones de la misma región.
• La especificación de OpenAPI se genera en formato YAML de forma predeterminada. Para generar y ver la especificación de OpenAPI en formato JSON, asigna el valor JSON al parámetro fileFormat en la llamada a la API.
• Actualmente, la integración de aplicaciones solo admite el siguiente conjunto limitado de palabras clave de esquema JSON:
  • type
  • items
  • properties
  • description
  • required
  • array
  • object
  • oneOf
  • allOf
  • anyOf
  • not
  • null
  • enum
  • additionalProperties
  • default
• Al validar la especificación de OpenAPI con el editor de Swagger, pueden producirse errores semánticos relacionados con las rutas de la API, como los que se muestran en la siguiente imagen:

  

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

Siguientes pasos

• Crea agentes conversacionales con Application Integration.
• Consulta información sobre los activadores de API.
• Consulta información sobre cómo probar y publicar integraciones.