Histórico da Página

Informações Gerais

Objetivo

Desenvolver uma ferramenta que efetue a exportação e publicação das estruturas das APIs Logix, desenvolvidos nos padrões determinados em LGX - Desenvolvimento de APIs, e o novo serviço, denominado GetSchema, que provê a consulta às estruturas publicadas.

Definição da Regra de Negócio

1. Introdução

Recentemente foram definidos novos padrões para o desenvolvimento de APIs API na tecnologia Logix 4GL que permitam sua publicação para utilização permitindo sua execução através de Web Services, porém . Porém, para permitir a execução desta API é necessária a uma ferramenta que permita a exportação destas.Tal ferramenta será responsável por efetuar a leitura do código fonte que possui as funções que serão publicadas e gerar suas estruturas em JSON e XML. Com estas estruturas geradas, a ferramenta deverá criar também duas novas funções ao final do código fonte para retorná-las no formato texto, possibilitando rápida recuperação destas no produto Logixefetue a exportação e publicação de sua estrutura de dados para que os serviços externos (como o TOTVS HTML Framework e EAI) saibam quais parâmetros de entrada e de saída deverão ser informados para a execução da mesma.

2. Nomenclatura das Funções

Para gerar a estrutura e pontos de entrada das APIs, a ferramenta deverá verificar os padrões de nomenclatura de funções - conforme descritos no documento TODO. O nome da função indicará como ficará o nome e o método de chamada através do WebService.

Exemplo:

#------------------------------------------------------------------------------#
FUNCTION logr4_pub_create_companies()
#------------------------------------------------------------------------------#
END FUNCTION

Sempre delimitada pelo caractere underscore, o nome da função indica como será a estrutura da função a partir de cada delimitador:

1. Código da API (logr4)
2. Identificador de publicação da função (sem o identificador pub, ela não será publicada)
3. Método de execução da função (create - verificar o item Métodos de Execução)
4. Nome da função (companies)

2.1. Métodos de Execução

Os métodos de execução definem qual método de requisição HTTP será utilizado para executar a função. Para aproximar o desenvolvimento das APIs ao desenvolvimento do produto Logix, será possível definir um apelido para os métodos de execução, como create, process e update - uma função definida com o nome logr4_pub_create_companies seria igual a uma função com o nome logr4_pub_post_companies por exemplo.

Os métodos de execução disponíveis atualmente são:

• POST, CREATE ou PROCESS: para inclusão ou processamento
• PUT ou UPDATE: para modificação
• DELETE: para exclusão
• GET ou QUERY: para recuperar uma ou mais informações

A execução REST da função da imagem acima, após sua publicação, teria uma requisição semelhante a abaixo:

POST /logix-rest/logr4/companies HTTP/1.1
Host: localhost:808

3. Nomenclatura dos Parâmetros

Para gerar os parâmetros de  

TODO: documentar nomenclatura dos parametros

TODO: documentar estrutura JSON

TODO: documentar estrutura XML

TODO: documentar funções de retorno da estrutura

TODO: gerar WADL

TODO: gerar WSDL

Protótipo de Tela