Como criar um pipeline usando uma especificação OpenAPI

Saiba mais sobre como criar a estrutura (scaffold) de um pipeline utilizando uma especificação OpenAPI na Digibee Integration Platform.

Na Digibee Integration Platform, você pode criar a estrutura (scaffold) de um pipeline a partir de uma especificação OpenAPI. Isso permite que as rotas e parte do fluxo sejam pré-configurados, acelerando a criação de pipelines enquanto garante a adesão às melhores práticas de fluxo de dados.

Como importar uma especificação OpenAPI

1. Na página Build, clique em Criar novo e selecione Pipeline com OpenAPI.

2. Na janela pop-up, carregue um arquivo YAML ou JSON. Você pode arrastar e soltar o arquivo ou selecioná-lo do seu computador.

3. Na próxima página, você verá uma pré-visualização da lista de rotas. Revise as informações para garantir que estão corretas. Se algo estiver incorreto, clique em Carregar outro arquivo para selecionar um novo arquivo com a configuração correta.

4. Quando estiver satisfeito com a configuração, clique em Confirmar.

Após a confirmação, você não poderá carregar outro arquivo. No entanto, é possível editar manualmente as rotas no formulário de configuração do API Trigger dentro do pipeline.

Pipeline gerado

Após importar o arquivo com a especificação OpenAPI, o scaffold do pipeline incluirá os seguintes elementos:

• O API Trigger, que serve como o ponto inicial do pipeline.

• Uma representação visual das rotas, cada uma conectada a um Router para gerenciar diferentes caminhos.

• Conectores Block Execution ao final de cada rota, organizando logicamente o pipeline em subfluxos para facilitar o gerenciamento e melhorar a clareza.

• Gerenciamento de respostas dentro dos subfluxos OnProcess e OnException de cada Block Execution, permitindo um controle de processos e erros mais estruturados.

Criando o fluxo a partir do pipeline gerado

Configurando o trigger

No pipeline estruturado, o trigger é pré-configurado com as rotas necessárias. No entanto, configurações adicionais devem ser feitas manualmente para garantir que o trigger funcione conforme suas necessidades. Para instruções detalhadas sobre como configurar o trigger, consulte a documentação do API Trigger.

Configurando os subfluxos

Embora parte do fluxo já esteja estruturada, você precisará continuar implementando a lógica da sua integração configurando os subfluxos nos conectores Block Execution no final de cada rota. Essa abordagem assegura que sua integração siga as boas práticas enquanto permanece gerenciável.

Editando as rotas

Você pode editar as rotas a qualquer momento por meio do formulário de configuração do trigger. Assim que salvar o trigger, qualquer alteração será refletida imediatamente no pipeline.

Se você alterar o API Trigger para outro tipo de trigger, o Router será convertido em um conector Choice, e as rotas configuradas anteriormente serão conectadas ao Choice. Você pode copiar os conectores dentro de cada Block Execution e colá-los em outro lugar no pipeline conforme necessário.