O objetivo deste documento é orientar o usuário quanto à configuração do ambiente para visualizar documentação do Swagger e permitir testes nas APIs existentes. Através dos tópicos abaixo, será exemplificado vamos exemplificar como configurar o ambiente corretamente para utilização dos serviços , mostrando e como é realizada realizar a segurança e autenticação através das APIs, além de exemplos de códigos utilizando os serviços disponíveis.
Expandir | |||||
---|---|---|---|---|---|
| |||||
Pré-Requisitos: Portal RM instalado. Para acessar o Swagger, é necessário acessar o link: "http://<servidor>:<portaFrameHTML>/swagger/ui/index" (Exemplo: http://localhost:8080/swagger/ui/index). Para verificar a porta, acesse, através do IIS, o Website "FrameHTML", que é gerado automaticamente quando realizada a instalação do Portal RM: Clique com o botão direito do mouse no Website "FrameHTML" e, em seguida, clique na opção "Editar ligações...". Conforme imagem abaixo, a porta seria a 8080, e o link ficaria da seguinte forma "http://localhost:8080/swagger/ui/index". Ao tentar acessar o link direto do Swagger, podem ocorrer erros conforme imagens abaixo: Para ajustá-los, é necessário realizar os seguintes procedimentos:
Arquivo Web.Config No diretório "X:\totvs\CorporeRM\FrameHTML", localize o arquivo de configurações "Web.Config". Certifique-se que a tag "owin:AutomaticAppStartup " está com o valor "true":
|
Expandir | ||
---|---|---|
| ||
Todos os serviços disponíveis no RM são agrupados e listados nesta ferramenta, que visa auxiliar na manutenção e documentação de APIs REST. Ao acessar o Swagger, são listados todos os serviços disponíveis, com a descrição do serviço, parâmetros e urls: |
Expandir | ||
---|---|---|
| ||
As APIs disponibilizadas no Swagger utilizam o Basic Authentication, que é o sistema de autenticação mais comum no protocolo HTTP. Para instruções e exemplos de geração, acesse o link Manual Operacional da Customização - LIB DN. O Token deve ser enviado em todas as requisições no cabeçalho HTTP "Authorization". No tópico abaixo são apresentados exemplos de utilização via POSTMAN e via código em diferentes linguagens. |
Expandir | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||
Seguem exemplos do consumo de um serviço customizado disponibilizado no Swagger. O método em que será feita a chamada é o ExecutaConsultaSQL, que realiza a execução de consultas SQL cadastradas no RM e retorna o resultado em JSON. O método utilizado é GET, e existem 4 parâmetros:
Requisição no Postman No Postman, devemos adicionar duas informações no cabeçalho (Header) da requisição, o Token (Authorization) e o Content-Type, para informar o tipo de dados utilizados, que, no caso das APIs da customização, é o JSON: Neste exemplo, vamos executar uma consulta que retorna os Municípios (Tabela GMUNICIPIO), sendo passado como parâmetro o Estado (CODETD). Exemplo do retorno no Postman: Exemplo das requisições em algumas linguagens de programação: C# (Utilizando a biblioteca RestSharp)
PHP
NodeJS (Utilizando biblioteca Request)
|
Informações | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||
|