Create from Connector

Você pode criar recursos a partir de conectores (connectors) que estejam habilitados na Plataforma. Leia mais sobre os conectores e como habilitá-los.

Para criar um recurso a partir de um conector:

  1. No menu API Catalog, vá até a tela de edição de recursos da API;

  2. Clique no botão Create from Connector;

  3. Selecione o conector que deseja na lista ou pesquise pelo nome;

  4. Clique em Create using instruction;

  5. Adicione o nome do recurso (obrigatório) e uma descrição (opcional).

Depois de criar o recurso, você será redirecionado para a tela de edição, onde poderá adicionar operações ao recurso:

  1. Clique em Add New Operation;

  2. Você deve informar o método HTTP e o caminho (path). Se desejar, insira uma descrição;

  3. No campo Instruction, utilize as palavras reservadas do conector. Esse campo possui a função autocompletar para ajudar a criar a instrução.

resourceFromConnector addOperation
Figure 1. Operação POST para um conector AWS Lambda

No exemplo acima, estamos criando uma operação do tipo POST para um conector AWS Lambda, que responderá no recurso /aws. O campo Instruction inclui as informações esperadas pela função.

O recurso salvo na API terá um rótulo do conector vinculado a ele:

resourceFromConnector resourceLabel

A API deve ser implantada no mesmo ambiente em que o conector está configurado. Faça o deploy na seção Environments da tela de Overview da API.

resourceFromConnector environments
O campo Instruction interpreta a sintaxe nativa do protocolo ao qual o conector dá acesso. Por exemplo, para conectores database, um conector Oracle não permite o uso de ; ao final da instrução, enquanto um conector MySQL permite.

Exemplo com conector SQL

Criando uma operação com o conector SQL para retornar uma consulta em uma tabela de banco de dados:

  1. Crie o recurso seguindo as instruções acima;

  2. Clique em Add New Operation;

  3. Selecione o método GET;

  4. No campo Path, insira: /users

  5. No campo Instruction, insira:

select * from users
$body.syntaxsql

O resultado será um JSON com os dados da consulta na tabela users seguindo a instrução fornecida.

Você pode usar parâmetros do header, path, query ou body na instrução do conector. Para isso, utilize as variáveis:

  • $headerParam.NOME_HEADER

  • $queryParam.NOME_QUERY

  • $pathParam.NOME_PATH

  • $body.NOME_ATRIBUTO

Consulte a subseção sobre variáveis dos conectores para mais detalhes sobre a sintaxe das variáveis.

Após salvar a API, você poderá realizar requisições ao recurso configurado.

Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]