Consulte os conetores suportados para a solução Application Integration.

Veja a especificação OpenAPI da sua integração

Pré-visualização — OpenAPI Specification

Esta funcionalidade está sujeita aos "Termos das Ofertas de Pré-DG" na secção Termos Gerais de Serviço dos Termos Específicos do Serviço. As funcionalidades de pré-DG estão disponíveis "tal como estão" e podem ter apoio técnico limitado. Para mais informações, consulte as descrições das fases de lançamento.

A integração de aplicações oferece a capacidade de gerar e ver dinamicamente as especificações da OpenAPI das suas integrações publicadas que estão configuradas com um ou mais acionadores de API. O acesso à especificação da OpenAPI da sua integração permite-lhe:

• Compreenda de forma abrangente os pontos finais da API, os métodos e as estruturas de dados da sua integração.
• Permita um desenvolvimento e uma resolução de problemas mais eficientes, fornecendo uma vista detalhada e centralizada da API da sua integração.
• Exponha as suas APIs de integração e integre-as perfeitamente com agentes de conversação. Consulte o artigo Crie agentes de conversação com a integração de aplicações.

O que é a especificação OpenAPI?

A especificação OpenAPI (OAS) é um formato padrão independente do idioma para descrever APIs RESTful. Normalmente escrita nos formatos YAML ou JSON, a especificação OpenAPI apresenta uma descrição formal dos elementos da API, como o respetivo URL base, caminhos e verbos, cabeçalhos, parâmetros de consulta, tipos de conteúdo, modelos de pedidos e respostas, entre outros. Para mais informações sobre a especificação OpenAPI, consulte o artigo Especificação OpenAPI.

Nota: a integração de aplicações só suporta a versão 3.0.1 da especificação OpenAPI.

Gere e veja a especificação OpenAPI

Pode gerar e ver dinamicamente a especificação OpenAPI para as suas integrações a partir do editor de integração na Google Cloud consola ou através de uma chamada API.

Antes de começar

• Confirme se a sua integração está configurada com um ou mais acionadores de API. Para obter informações sobre a configuração de acionadores de API, consulte o artigo Acionadores de API.
• Publique a integração. Para obter informações sobre como publicar uma integração, consulte o artigo Teste e publique integrações.

Veja a especificação OpenAPI

Para ver a especificação OpenAPI da sua integração, selecione uma das opções:

Consola

Para ver a especificação da OpenAPI de uma integração específica, siga estes passos:

1. Aceda à página Application Integration.

   Aceda à solução Application Integration

2. No menu de navegação, clique em Integrações.

   É apresentada a página Integrações, que lista todas as integrações disponíveis no Google Cloud projeto.

3. Clique na integração para a qual quer ver a especificação OpenAPI. Esta ação abre a integração no editor de integrações.
4. Clique em (menu Ações) na barra de ferramentas do editor de integração e selecione Ver especificação OpenAPI.

   O painel Ver especificação OpenAPI é apresentado com a especificação OpenAPI da integração. Por predefinição, a especificação OpenAPI gerada contém todos os acionadores de API configurados na integração.

   • Para ver a especificação OpenAPI de um acionador de API específico, selecione o acionador de API na lista pendente APIs.
   • Para transferir a especificação OpenAPI como um ficheiro YAML, clique em transferir (Transferir).

Nota: só pode ver e transferir a especificação OpenAPI, no formato YAML, para uma única integração de cada vez a partir do editor de integração. Para ver e transferir a especificação OpenAPI nos formatos YAML ou JSON, siga as instruções na secção API.

API

O método generateOpenApiSpec da API Application Integration permite-lhe ver a especificação OpenAPI para a sua integração através de uma chamada API.

Use o seguinte comando curl para ver a especificação OpenAPI de uma ou mais integrações na mesma região:

Sugestão: o curl é normalmente pré-instalado nos sistemas operativos Linux e macOS. Se não tiver o curl, pode transferi-lo na curl página de lançamentos e transferências.

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"
          

Substitua o seguinte:

• TRIGGER_NAME, TRIGGER_NAME_2, TRIGGER_NAME_n: os nomes do acionador da API na sua integração para os quais quer ver a especificação OpenAPI.
• INTEGRATION_NAME: o nome da sua integração.
• DOC_TYPE: O tipo de documento a gerar. Os seguintes valores são suportados: YAML ou JSON.
• PROJECT_ID: o ID do seu projeto Google Cloud .
• LOCATION: a localização do seu Google Cloud projeto.
  Nota: só pode ver a especificação OpenAPI para várias integrações na mesma região.

Compreender a especificação OpenAPI

A integração de aplicações gera a especificação OpenAPI para as suas integrações publicadas de acordo com a norma especificação OpenAPI 3.0. A tabela seguinte descreve os elementos da especificação OpenAPI gerada na integração de aplicações:

Elemento	Descrição
openapi	A versão da especificação OpenAPI usada.
info	Informações sobre a integração, como o nome (título), a descrição e a versão publicada.
servers	Os URLs do servidor que alojam a integração.
paths	São criados caminhos para cada acionador da API selecionado na integração. O URL do servidor combinado com o caminho constitui o ponto final da API para fazer chamadas à API. Os campos Request e Response são preenchidos com base nas variáveis de entrada e saída configuradas para o acionador da API correspondente. Nota: atualmente, a integração de aplicações só suporta um conjunto limitado de palavras-chave do esquema JSON. Para informações sobre as palavras-chave suportadas, consulte as Considerações.
components	O campo schemas contém o esquema JSON para as variáveis de entrada e saída do acionador de API. O campo securitySchemes contém as informações de autenticação para os acionadores da API.

Considerações

As seguintes considerações aplicam-se quando vê a especificação OpenAPI para a sua integração:

• A especificação OpenAPI é gerada apenas para integrações publicadas.
• A especificação OpenAPI é gerada apenas para integrações configuradas com um ou mais acionadores de API.
• A especificação OpenAPI é gerada apenas para integrações na mesma região.
• A especificação OpenAPI é gerada no formato YAML por predefinição. Para gerar e ver a especificação OpenAPI no formato JSON, defina o parâmetro fileFormat como JSON na chamada da API.
• Atualmente, a integração de aplicações suporta apenas o seguinte conjunto limitado de palavras-chave do esquema JSON:
  • type
  • items
  • properties
  • description
  • required
  • array
  • object
  • oneOf
  • allOf
  • anyOf
  • not
  • null
  • enum
  • additionalProperties
  • default
• Quando valida a especificação OpenAPI através do Swagger Editor, pode encontrar erros semânticos relacionados com os caminhos da API semelhantes à seguinte imagem:

  

  Estes erros podem ser ignorados em segurança. A especificação OpenAPI ainda é válida.

O que se segue?

• Crie agentes conversacionais com a integração de aplicações.
• Saiba mais sobre os acionadores de API.
• Saiba mais sobre como testar e publicar integrações.