Pré requisitos
- Projeto do tipo web criado. Caso haja dúvidas de como criar esse tipo de projeto acesse o link (Criando Projeto Web).
- Criar classes no Diagrama, gerar persistência e popular o banco. Para criar classes e gerar persistência acesse o link (Geração da camada de dados a partir do diagrama).
Passos
Para esse exemplo vamos criar um agenda simples, utilizando um relacionamento de 1 para N, onde um cliente pode possuir vários telefones. (Figura 1)
Figura 1 - Relacionamento usado nesse exemplo.
1. Criando Bloco de programação
Crie um bloco de programação do lado Servidor. Nesse exemplo, nomeamos o bloco para "WebServiceRest" e uma função "cliente" que recebe o parâmetro identificador do cliente "idC" e retorna os dados desse cliente.
Como a função deve só retornar os dados do banco, configuramos a consulta para enviar direto no retorno da função, passando o parâmetro recebido na função que será informada no endereço da requisição. (Figura 2)
Figura 2 - Configurando o bloco de programação e consulta.
2. Configurando a chamada Rest
Após finalizar a lógica da função, clique na engrenagem "Configuração dos tipos de regras" (lado direito/superior) para abrir a janela de "Propriedades do bloco de programação". Nessa janela, os únicos campos que nos interessam para a configuração do REST são os campos descritos abaixo. (Figura 3)
- Tempo limite: Limite em segundos para a execução. Após o limite, o bloco é finalizado.
- Tipo: Tipo externo gera Rest e tipo interno gera função.
- Segurança: Abre uma outra janela que nos permite dar autorização de CRUD e Execução a diferentes perfis de segurança.
Autorize para "Todos" os campos: Permitir Executar e Permitir Obter.
Figura 3 - Configuração da chamada REST.
Salve as alterações para que o CronApp gere todas as notações necessárias para as requisições Rest com a alteração do campo Tipo como Externo nas Propriedades do Bloco de programação do lado Servidor. (Figura 4) Como vimos, todo esse processo é feito em Low Code ou RAD.
Figura 4 - Notações REST gerado pelo CronApp ao alterar as propriedades do Bloco.
3. Obter o endereço Rest
O modelo da URI Rest para esta função está descrita no campo "Rest" (Figura 3): /api/cronapi/rest/blockly.WebServiceRest:<Função>[/<Parâmetro 1>[/Parâmetro n]]
Antes do modelo acima, é necessário inserir o domínio do sistema. Como estamos em modo desenvolvimento, precisamos executar a aplicação para verificar o endereço temporário gerado pelo CronApp, como mostrado na Figura 4.
Figura 4 - Domínio de desenvolvimento gerado pelo CronApp.
Ao final, o endereço que iremos usar para consumir o recurso é:
https://9-211-10090.debug.ide.cronapp.io/api/cronapi/rest/blockly.WebServiceRest:cliente/<id do Cliente>
4. Testando o Serviço
Existem diversos aplicações para testar serviços Rest: Programas, extensões de navegadores e até sites. Estamos utilizando a aplicação Postman.
Informe o tipo de Verbo ou método HTTP, nesse caso estamos usando GET, o endereço completo e clique em "Send" para retornar o conteúdo referente ao cliente de id = 2, como exibido na Figura 5.
Figura 5 - Teste da requisição em outro sistema.