Importar um documento OpenAPI (Swagger) para criar um endpoint no Jitterbit App Builder

Introdução

Desde a versão 4.45, é possível criar um endpoint REST a partir de um documento OpenAPI (Swagger). O App Builder utiliza a biblioteca OpenAPI.net e suporta versões de documentos do Swagger 2.0 até o OpenAPI 3.1, inclusive.

Você pode criar um endpoint a partir de qualquer um destes locais:

• IDE > Servidores de Dados

• App Workbench > Fontes de Dados

Esta página mostra os passos para ambos.

Criar um endpoint REST a partir de um documento OpenAPI (Swagger) via o IDE

Siga estes passos:

1. Selecione IDE > Servidores de Dados.

2. Clique no botão + Servidor. A caixa de diálogo Servidor se abre.

3. Defina os valores para os seguintes campos:

   • Nome do Servidor: Insira um nome para o servidor.

   • Tipo: Selecione REST API. (REST é selecionado automaticamente para Subtipo.)

   • URL: Insira a raiz do endpoint (URL base).

   • (Opcional) Descrição: Insira uma descrição.

4. Clique no botão Salvar.

   O seguinte exemplo utiliza a URL do documento de teste OpenAPI https://ipinfo.io/developers/openapi.yaml:

   

5. Na caixa de diálogo Servidor, clique no ícone Endpoints.

6. No painel Web Service, clique no botão Importar. A primeira página da caixa de diálogo do assistente Importação de Web Service se abre:

   

7. Selecione uma das seguintes abas, dependendo de como você deseja fornecer seu documento:

   • URL: Selecione para fornecer uma URL para o documento.

   • Documento: Selecione para colar o conteúdo de um documento.

8. Upload: Selecione para fazer o upload de um documento do seu sistema de arquivos.

9. Clique no botão Next. A segunda página do diálogo do assistente Web Service Import é aberta:

   

10. (Opcional) Para importar um ou mais endpoints, faça uma das seguintes ações:

    • Insira um padrão no campo Import by Name, em seguida, clique no botão Import.

      Um padrão é uma lista delimitada por vírgulas de expressões curinga que selecionam um subconjunto de tabelas para importar. Cada padrão usa a sintaxe LIKE do mvSQL. Você pode usar % para corresponder a zero ou mais caracteres, e _ para corresponder a um único caractere. Caracteres entre colchetes (por exemplo, [abc]) correspondem a qualquer caractere no grupo.

    • Clique em qualquer um dos botões Import Schema para importar endpoints.

11. Clique no botão Finish.

Criar um endpoint REST a partir de um documento OpenAPI (Swagger) via o App Workbench

Siga estas etapas:

1. Selecione App Workbench no painel de ações, ou Workbench no menu do aplicativo, em seguida, clique em Data Sources.

2. Clique no botão + Source. O diálogo Add a Source to your Application é aberto.

3. Selecione a opção New Connection, em seguida, clique no botão Next. A página do assistente Choose Connection Type é aberta.

4. Em Connection Category, selecione a opção REST.

5. Em Types of Connections, selecione a opção REST API, em seguida, clique no botão Next.

6. Selecione ou configure um provedor de segurança, ou clique no botão Skip. A página do assistente Create New Connection é aberta.

7. Clique no botão Import. O diálogo Import New Connection é aberto:

   

8. Selecione uma das seguintes abas, dependendo de como você deseja fornecer seu documento:

   • URL: Selecione para fornecer uma URL para o documento.
   • Document: Selecione para colar o conteúdo de um documento.
   • Upload: Selecione para fazer o upload de um documento do seu sistema de arquivos.

9. Clique no botão Próximo. A caixa de diálogo Criar Endpoints é aberta:

   

10. Clique no botão Importar. A caixa de diálogo Importação de Serviço Web é aberta novamente:

    

11. Clique no botão Próximo.

12. (Opcional) Para importar um ou mais endpoints, faça uma das seguintes ações:

    • Insira um padrão no campo Importar por Nome, em seguida, clique no botão Importar.

      Um padrão é uma lista delimitada por vírgulas de expressões curinga que selecionam um subconjunto de tabelas para importar. Cada padrão usa a sintaxe LIKE do mvSQL. Você pode usar % para corresponder a zero ou mais caracteres, e _ para corresponder a um único caractere. Caracteres entre colchetes (por exemplo, [abc]) correspondem a qualquer caractere do grupo.

    • Clique em qualquer um dos botões Importar Esquema para importar endpoints.

13. Clique no botão Concluir. A página do assistente Criar Endpoints reaparece:

    

14. Para testar os endpoints, clique em qualquer um dos ícones na coluna Status. Quando bem-sucedido, o ícone muda para :

    

15. Clique no botão Próximo. A caixa de diálogo Resumo da Nova Fonte de Dados é aberta:

    

16. Clique no botão Concluído.