Linha Logix

Páginas filhas
  • 1. Nomenclatura das Funções

Versões comparadas

Versão antiga 21

changes.mady.by.user Usuário desconhecido (rubens.santos)

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Eduardo Filipe Gomes

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Aviso
titleImportante

O conteúdo relacionado na página abaixo foi substituído e será descontinuado em releases futuras.

A nova técnica para desenvolvimento de API poderá ser consultada através do seguinte endereço (http://tdn.totvs.com/x/6BE4Fw) e esta disponível a partir da release 12.1.22 do Logix.


A declaração do nome da função terá fundamental importância neste desenvolvimento, pois é isso que definirá se a função da API ficará pública e como será a execução da função a partir de serviços web. Segue abaixo um exemplo de definição:

...

Seguindo o padrão de desenvolvimento atual, todas as funções da API devem iniciar com o nome do objeto de negócio correspondente.

Exemplos:

Objeto de NegócioFunção
supr4
supr0004
supr4
supr0004_pub_update_item, supr4_pub_delete_item
manr99
manr0099
manr99
manr0099_pub_delete_estrutura, manr99_verifica_estrutura
obfr21
obfr0021
obfr21
obfr0021_atualiza_nota, obfr21_process_emiteNota

1.3 Identificador de Publicação

...

Abaixo segue a tabela de conversão dos métodos HTTP para o método de execução das funções 4GL:

Método de ExecuçãoMétodo HTTPObjetivo
createPOSTCriação de um ou mais registros.
processPOSTProcessamento de dados ou geração de relatórios.
update

PUT

Atualização de um ou mais registros.
getGETConsulta a um ou mais registros.
deleteDELETEExclusão de um ou mais registros.

Os métodos de requisições HTTP existentes podem ser consultados através deste link: http://www.w3schools.com/tags/ref_httpmethods.asp.

...

Nota

Para nomes de funções com mais de uma palavra evite utilizar delimitadores, use o formato de classe sendo a primeira palavra em minúscula e o restante com a primeira letra maiúscula. Isto fará com que a URL de execução da função fique mais clara.

Exemplo:

FUNCTION logr3logr0003_pub_create_inclusaoDimensaoEmpresa
FUNCTION obfr10obfr0010_pub_process_enviaEmailTransportadora
FUNCTION supr10supr0010_pub_process_centralizaConsultaEstoqueProprio

Segue abaixo exemplo de definição de funções e como será realizada a requisição web de execução destas funções:

FunçãoRequisição

FUNCTION

logr3

logr0003_pub_create_inclusaoDimensao()

POST /logix-rest/logr3/inclusaoDimensao

FUNCTION
obfr10
obfr0010_pub_process_emailTransportadora()POST /logix-rest/obfr10/emailTransportadora
FUNCTION
supr10
supr0010_pub_update_estoqueProprio() PUT /logix-rest/supr10/estoqueProprio 
FUNCTION
manr21
manr0021_pub_get_apontamento_horas() GET /logix-rest/manr21/apontamento_hora