Histórico da Página

Informações Gerais

Objetivo

Desenvolver uma ferramenta que efetue a exportação e publicação das APIs Logix permitindo a execução das mesmas a partir de Web Services. A publicação deverá possibilitar que ferramentas como EAI e o TOTVS HTML Framework possam executar as APIs através de serviços SOAP ou REST.

Definição da Regra de Negócio

Introdução

Recentemente foram definidos padrões para o desenvolvimento de APIs na tecnologia 4GL que permitam sua publicação para utilização através de Web Services, porém é necessária a ferramenta que permita a exportação destas.

Tal ferramenta será responsável por efetuar a leitura do código fonte que possui as funcionalidades 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 Logix.

Nomenclatura das Funções

Para gerar a estrutura e os pontos de entrada, 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 da funcionalidade da API.

Exemplo:

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 funcionalidade (se a FUNCTION não possuir o identificador pub ela não será publicada)
3. Método de execução da funcionalidade (create - verificar o item Métodos de Execução)
4. Nome da funcionalidade (companies)

Métodos de Execução

Os métodos de execução definem qual método de requisição HTTP será utilizado para executar a funcionalidade, atualmente é possível definir um alias, como create para POST e update para PUT - 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
  
  

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

Opcional

Protótipo de Tela

<Caso necessário inclua protótipos de telas com o objetivo de facilitar o entendimento do requisito, apresentar conceitos e funcionalidades do software>.

Protótipo 01

Opcional

Fluxo do Processo

<Nesta etapa incluir representações gráficas que descrevam o problema a ser resolvido e o sistema a ser desenvolvido. Exemplo: Diagrama - Caso de Uso, Diagrama de Atividades, Diagrama de Classes, Diagrama de Entidade e Relacionamento e Diagrama de Sequência>. 

Opcional

Dicionário de Dados

Arquivo ou Código do Script: AAA – Negociação Financeira / *Versao=CP.2014.12_03*/

(Opcional)

Grupo de Perguntas

<Informações utilizadas na linha Protheus>.

Nome: FINSRF2

(Opcional)

Consulta Padrão

<Informações utilizadas na linha Protheus>

Consulta: AMB

(Opcional)

Estrutura de Menu

<Informações utilizadas na linha Datasul>.

Procedimentos

Programas

Cadastro de Papéis

<O cadastro de papéis é obrigatório para os projetos de desenvolvimento FLEX a partir do Datasul 10>.

<Lembrete: o nome dos papeis em inglês descrito neste ponto do documento, devem ser homologados pela equipe de tradução>.