# Como criar um pipeline usando uma especificação OpenAPI

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**.

{% hint style="info" %}
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**](/documentation/connectors-and-triggers/pt-br/triggers/web-protocols/api.md) dentro do pipeline.
{% endhint %}

<figure><img src="/files/vay1txlqYHiNNc0mA78l" alt=""><figcaption></figcaption></figure>

## **Pipeline gerado**

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

* O [**API Trigger**](/documentation/connectors-and-triggers/pt-br/triggers/web-protocols/api.md), 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**](/documentation/connectors-and-triggers/pt-br/connectors/logic/block-execution.md) 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**](/documentation/developer-guide/pt-br/development-cycle/build-overview/pipelines/subpipelines.md#onprocess) e [**OnException**](/documentation/developer-guide/pt-br/development-cycle/build-overview/pipelines/subpipelines.md#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**](/documentation/connectors-and-triggers/pt-br/triggers/web-protocols/api.md).

#### **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**](/documentation/connectors-and-triggers/pt-br/connectors/logic/block-execution.md) 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.

{% hint style="warning" %}
Se você alterar o [**API Trigger**](/documentation/connectors-and-triggers/pt-br/triggers/web-protocols/api.md) para outro tipo de trigger, o **Router** será convertido em um conector **Choice**, e as rotas configuradas anteriormente serão conectadas ao [**Choice**](/documentation/connectors-and-triggers/pt-br/connectors/logic/choice.md). Você pode copiar os conectores dentro de cada [**Block Execution**](/documentation/connectors-and-triggers/pt-br/connectors/logic/block-execution.md) e colá-los em outro lugar no pipeline conforme necessário.
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.digibee.com/documentation/developer-guide/pt-br/development-cycle/build-overview/pipelines/how-to-scaffold-a-pipeline-using-an-openapi-specification.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
