Informação geral

O último módulo terminou com a criação do primeiro processo empresarial. Descobrimos como criar a lógica do processo, aceitar parâmetros de entrada específicos, realizar cálculos e emitir uma resposta. Resta-nos responder à pergunta principal. Como activar o processo de negócio criado e pô-lo em funcionamento?

Para resolver este problema, são pretendidos pontos finais - pontos-chave de interacção com a aplicação. Nos primeiros módulos, já interagimos com APIs externas. Isto foi possível graças à presença de endpoints. Estes foram descritos na documentação, e lemos e compreendemos qual o método e qual o URL necessário para enviar um pedido de acesso a um recurso específico.

Para compreender, vejamos a implementação de endpoints utilizando um exemplo específico. No terceiro módulo, foi criado o modelo da base de dados. Ao mesmo tempo, em simultâneo com a criação de tabelas, foram criados automaticamente pontos finais para interagir com eles. Vamos à secção de pontos finais (no painel da esquerda) e vejamo-los.

No exemplo da tabela "city" com informação sobre as cidades, pode-se ver que já tem 6 pontos finais para operações de dados básicos.

• GET /city - obter todos os dados de uma tabela
• GET /city/:id - obter dados sobre a cidade com a identificação especificada
• POST /city - adicionar um novo registo à tabela
• PUT /city/:id - substituição completa do registo pelo id especificado na tabela
• PATCH /city/:id - substituição parcial de um registo com a identificação especificada na tabela
• DELETE /city/:id - apagar um registo com o id especificado da tabela

Definições gerais

É possível abrir as definições para cada parâmetro e estudá-lo com mais detalhe. Por exemplo, considere o ponto final GET /city/:id

A imagem que vemos é muito semelhante à que já vimos quando criámos um pedido a APIs externas. Num caso, apenas acedemos a um endpoint pronto, e agora estamos nós próprios a criar e a configurar este endpoint. Para configurar, é necessário especificar:

1. Método de pedido. Neste exemplo, este é o método GET.
2. Solicitar URL. A primeira parte com o caminho para o servidor não está especificada. É o mesmo para todos os pontos finais da aplicação. É suficiente especificar apenas o final (/city). O parâmetro URL também é especificado aqui. O ponto final é concebido para receber informação sobre uma determinada cidade, pelo que o seu id escrito após ":" é passado como parâmetro.
3. Endpoint Groups. Este parâmetro não afecta de modo algum o funcionamento do ponto final e destina-se apenas à conveniência da organização. Todos os pontos finais podem ser divididos em grupos temáticos (pastas). Neste exemplo, o grupo "city" contém todos os pontos finais para trabalhar com dados sobre cidades.
4. Business Process. Este é o item de configuração mais importante e é algo que não podia ser visto de forma alguma quando se envia um pedido ao ponto final. A indicação do processo empresarial determina o que este parâmetro irá fazer. Ao mesmo tempo, o próprio endpoint pode permanecer inalterado, receberá todos os mesmos pedidos no endereço antigo, e ao mesmo tempo, se o processo empresarial for substituído, desempenhará uma função completamente diferente. Os processos de negócio para actividades básicas da base de dados são criados automaticamente. São chamados processos empresariais de sistema. Tais BPs não podem ser alterados, mas podem ser substituídos em qualquer altura por BPs criados independentemente, com processos de negócios personalizados.
5. Input/Output variables. O processo de negócio criado utiliza várias variáveis de entrada e saída, mas o ponto final não tem de utilizar todas elas. A parte pode ser desactivada ou configurada de modo a que diferentes parâmetros acedam ao mesmo BP, com um conjunto individual de variáveis. O tipo de pedido e resposta (Request / Response type) também é aí configurado. Na maioria das vezes, este tipo será JSON, mas, se necessário, podem ser utilizadas outras opções, tais como XML ou Render File (este tipo de resposta é utilizado em endpoints para trabalhar com ficheiros).

Definições de middleware

As configurações gerais são suficientes para criar e utilizar o ponto final, mas podem ser utilizados parâmetros adicionais, se necessário. O mais importante destes é a activação de Middleware com um símbolo Auth.

A sua utilização permite negar o acesso a este endpoint a utilizadores que não tenham sido autorizados ou não pertençam a um determinado grupo (por exemplo, o acesso só pode ser concedido a administradores e negado a outros utilizadores).

Configurações de registo e de saída

Além disso, pode utilizar as definições no separador Settings para registar adicionalmente os cabeçalhos ou o corpo do pedido, bem como para esconder da resposta aqueles campos cujos valores não estão definidos.