Árvore de páginas

Versões comparadas

Chave

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

Tempo aproximado para leitura: 2 min


01. Objetivo

         O SARA | RESTServer é um novo serviço provedor de API´s para o sistema SARA, permitindo assim a construção de novas funcionalidades "back-end" para serem consumidas por outras aplicações "front-end" ou por outros serviços por meio do protocolo HTTP (Web Service REST). 

02. Arquitetura

        

Image Removed

Abaixo segue um exemplo básico com um passo-a-passo da execução de uma requisição REST:

1) Uma aplicação cliente (Front-end), faz uma requisição REST com base em uma URL, onde é informado o método (GET, POST, PUT ou DELETE) e alguns parâmetros obrigatórios conforme documentação SWAGGER de cada API.

Exemplo: URL para consulta de todos os registro referente ao cadastro de unidades de medida.

GET | http://localhost:8081/api/sara/tabelas-dominio/v1/unidades-medida

2) Após o envio, o servidor por meio do Serviço SARA | RESTServer processa a requisição.

O arquivo APPServer.EXE, recebe a requisição e efetua a autenticação segura via TOKEN JWT.

Após a realização da autenticação, por meio da URL, valida se a ROTA existe e se o usuário da requisição tem acesso a funcionalidade.

Com a ROTA validada, o serviço pesquisa qual o nome da BPL relacionada a ROTA, e efetua a execução da BPL passando os parâmetros da requisição HTTP. Neste exemplo a BPL que será chamada é a UnidadeMedida.BPL,

3) Cada arquivo BPL tem a responsabilidade de validar os parâmetros da requisição de acordo com o método (GET, POST, PUT ou DELETE). As BPL possuem as regras de negócio de cada domínio, efetuando cálculos, consulta e gravações ao banco de dados.

4) Para acesso ao banco de dados, cada BPL de negócio executa o arquivo DATA.bpl, que é responsável exclusivamente pela conexão com o banco de dados e a execução dos SQL's enviados pela BPL de negócio.  

5) Após a requisição de consulta ou gravação ao banco de dados, a BPL de negócio devolve um RESPONSE para o serviço (APPServer.exe) contendo o status do resultado e um JSON com as informações se for o caso. Abaixo segue um exemplo do JSON da pesquisa da unidade de medida:

Bloco de código
languagetext
firstline1
titleResponse GET - UnidadeMedida.BPL
{
    "hasNext": true,
    "items": [
        {
            "idUnidadeMedida": "BO",
            "descricaoUnidadeMedida": "BOBINA"
        },
        {
            "idUnidadeMedida": "BR",
            "descricaoUnidadeMedida": "BARRIL"
        },
        {
            "idUnidadeMedida": "CC",
            "descricaoUnidadeMedida": "CONTEINER"
        },
        {
            "idUnidadeMedida": "CM",
            "descricaoUnidadeMedida": "CAIXA MADEIRA"
        },
        {
            "idUnidadeMedida": "CP",
            "descricaoUnidadeMedida": "CAIXA PAPELAO"
        },
        {
            "idUnidadeMedida": "CT",
            "descricaoUnidadeMedida": "CAIXA METAL"
        }        
    ],
    "_messages": [
        {
            "codigo": "200",
            "message": "Aviso",
            "detailedMessage": "Dados retornados!"
        }
    ]
}

03. Manual de instalação

Este manual tem como objetivo auxiliar na instalação e configuração do serviço SARA | RESTServer.


02. Arquivos para instalação

Os arquivos para a instalação do serviço pode ser encontrado dentro do pacote de expedição oficial do sistema SARA, ou por meio de pacotes incrementais somente destinado ao RESTServer.

Como exemplo, abaixo segue a pasta com os arquivos localizados dentro do pacote de expedição 12.01.41.00, Para a instalação e configuração do serviço, acessar a página ...













Templatedocumentos


HTML
<style>
div.theme-default .ia-splitter #main {
    margin-left: 0px;
}
.ia-fixed-sidebar, .ia-splitter-left {
    display: none;
}
#main {
    padding-left: 10px;
    padding-right: 10px;
    overflow-x: hidden;
}

.aui-header-primary .aui-nav,  .aui-page-panel {
    margin-left: 0px !important;
}
.aui-header-primary .aui-nav {
    margin-left: 0px !important;
}
</style>