Create from Connector

É possível criar recursos a partir de connectors (conectores) que estejam habilitados na Plataforma. Leia mais sobre os connectors e sobre como habilitá-los aqui.

Para criar um recurso a partir de um conector, clique no botão Create from Connector na tela de edição de recursos de uma API (dentro do menu APIs). Todos os connectors que estiverem habilitados para conexão serão exibidos e você pode também pesquisar pelo nome do conector.

resourceFromConnector

Depois de selecionar um conector, clique na opção Create using instruction. Adicione o nome do recurso (Resource Name), que é obrigatório, e uma descrição, se desejar.

Depois de criado o recurso, você será redirecionado à tela de edição novamente, onde poderá adicionar as operações para o recurso (clicando em Add New Operation).

Informe o método HTTP (obrigatório), caminho (path, obrigatório) e descrição (não obrigatória). Na área para descrever a instrução (Instruction), cada connector terá suas palavras reservadas com função AutoCompletar para ajudar na criação da sentença.

resourceFromConnector addOperation

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 campo Instruction entende a sintaxe nativa do protocolo ao qual o conector permite acesso. Um exemplo para database connectors: ao passar uma instrução para um conector de tipo Oracle, não se permite uso de ; ao final da instrução, diferente de um conector MySQL, em que ; é utilizado.

Outro exemplo dessa etapa é a imagem abaixo. Nesse caso (de um conector SQL), a operação cadastrada retornará uma consulta em uma tabela de banco de dados. Mais especificamente, o resultado será um JSON com os dados da consulta na tabela users (path) e seguindo a instrução cadastrada.

resourceFromConnector addOperationGET

É possível utilizar parâmetros do header, path, query ou body na instrução do conector. Para isso, basta utilizar as variáveis $headerParam.NOME_HEADER, $queryParam.NOME_QUERY, $pathParam.NOME_PATH ou $body.NOME_ATRIBUTO.

Temos uma subseção para ajudar com a sintaxe das variáveis dos connectors.

Voltando ao exemplo do AWS Lambda, o recurso a ser salvo na API terá um label do conector vinculado a ele:

resourceFromConnector resourceLabel

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

resourceFromConnector environments

Após salvar a API, será possível realizar uma requisição ao recurso que foi configurado.

Thanks for your feedback!
EDIT

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