Visualizar documentação do Swagger

Síntese

O objetivo deste documento é de 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 abaixos, será exemplificado como configurar o ambiente corretamente para utilização dos serviços, como é realizada a segurança e autenticação através das APIs além de exemplos de códigos utilizando os serviços disponíveis.


Ao tentar acessar o link direto do Swagger, pode ocorrer os dois erros registrados nas imagens abaixo:





Dentro do servidor, abra o diretório "C:\totvs\CorporeRM\FrameHTML\bin", localize o arquivo RM.WebAPI.xml no diretório, e altere o nome para RM.WebAPI.Documentation.xml.


No mesmo diretório, localize também o arquivo RM.Fop.WebApi.dll e apague-o da pasta.


Todos os serviços disponíveis no RM são agrupados e listados nessa ferramenta, que visa auxiliar na manutenção e documentação de APIs REST.

Para acessar o Swagger, é necessário acessar o link no seguinte formato "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 quando realizada a instalação do Portal RM:


Após isso, basta clicar com o botão direito do mouse no Website "FrameHTML" e clicar 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 acessar o Swagger, serão listados todos os serviços disponíveis, com a descrição do serviço, parâmetros e urls:



As APIs disponibilizadas no Swagger utilizam o Basic Authentication, que é o sistema de autenticação mais comum no protocolo HTTP.
Na tela de parâmetros da Lib DN, que é pré-requisito para todas as customizações, existe um processo que permite gerar o Token de forma simples.


Para instruções e exemplos de geração, acesse o link abaixo:

Manual Operacional da Customização - LIB DN


O Token deverá ser enviado em todas as requisições no cabeçalho HTTP "Authorization". Nos tópicos abaixo serão apresentados exemplos de utilização via POSTMAN e via código em diferentes linguagens.


A seguir, serão exibidos 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:

  • codColigada (Código da Coligada da Sentença SQL)
  • codSentenca (Código da Sentença)
  • parameters (Parâmetros que são utilizados na consulta)
  • codSistema (Código do sistema onde a consulta foi cadastrada)


Segue a visualização do método no Swagger:



Produto: Customizações

Versão: 12.1.17 ou Superiores

Data:  

Ana Carolina Eleutério Abras

Pedro Antonio Silva Barroso