Portuguese

Conceito

...

Uma API - (acrônimo de Application Programming Interface, ou  ou Interface de Programação de Aplicação em português, ) é um conjunto de rotinas e padrões estabelecidos por um software para a utilização das suas funcionalidades de seus recursos por aplicativos que não pretendem envolver-se em detalhes da implementação do software, mas apenas usar seus serviços. De modo geral, uma API é composta por uma série de funções acessíveis somente por programação e que permitem utilizar características do software menos evidentes ao utilizador usuário tradicional.

...

...

...

Desenvolvimento

...

Para o correto desenvolvimento é preciso ter em mente alguns cuidados que devem ser sempre considerados na construção de uma API:

• Nunca

...

•  desenvolva ou solicite qualquer interação com o usuário, seja ela através de telas, mensagens ou perguntas;
• Simplifique suas funções, não é uma boa prática construir uma função "faz tudo", separe sempre sua lógica em diversas funções que possam ser executadas de formas distintas;
• Evite

...

•  que suas funções dependam do produto, lembre-se que elas poderão ser executadas através de outros produtos ou

...

• serviços; e
• Sempre

...

•  desenvolva visando a solução de único objetivo de negócio

...

• . Uma API para manutenção de pedidos não pode conter manutenção de empresas, por exemplo.

Para iniciar o desenvolvimento de uma API no Logix, crie seu código fonte utilizando o Controle de Fontes Logix e Datasul disponível no GCAD-TOOLS. Nos próximos itens deste documento, serão detalhados os padrões detalhadas as técnicas que devem ser seguidos na construção dos códigos fonte das APIs.

2.1 Nomenclatura das Funções

A declaração do nome da função terá fundamental importância neste desenvolvimento, pois é este 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:

Image Removed

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

1. Nome da API (logr2)
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)
4. Nome do método (companies)

Abaixo seguem maiores detalhes de como cada uma das informações acima devem ser declaradas.

2.1.1 Nome da API

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:

2.1.2 Identificador de Publicação

O identificador _pub_ indica que a função ficará exposta publicamente para execução a partir de outros serviços externos, independente de produto ou tecnologia. Uma função dentro da API sem este identificador será considerada como interna, ou seja, acessível apenas pelo produto Logix.

2.1.3 Método de execução

O método de execução indica como será realizada a chamada da função através de um serviço web, ou seja, qual método de requisição HTTP terá que ser utilizado para sua execução. Os métodos de requisições HTTP podem ser consultados através deste link: http://www.w3schools.com/tags/ref_httpmethods.asp.

O método de execução deve ser definido conforme o objetivo da função 4GL, abaixo segue a tabela de conversão dos métodos HTTP para o tipo de execução que deverá ser definida no nome da função 4GL: