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 API na tecnologia Logix 4GL permitindo sua execução através de Web Services. Porém, para permitir a execução desta API é necessária uma ferramenta que efetue 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. Funcionamento

A ferramenta de publicação será responsável por ler o conteúdo do código fonte da API e gerar a estrutura de todos os métodos públicos encontrados e seus respectivos parâmetros de entrada e saída. Após gerada a estrutura no formato JSON, a ferramenta deve disponibilizar um meio do desenvolvedor copiá-la para o código fonte informado, a API ficará disponível publicamente para execução apenas apenas após a compilação do código fonte no RPO com a estrutura copiada.

Protótipo de Tela

Imagem 1: tela para informação do código fonte da API.

Imagem 2: estrutura gerada e exibida em tela para cópia.

Imagem 3: lista das APIs já publicadas anteriormente pela ferramenta.