Histórico da Página
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.
| Expandir | ||
|---|---|---|
| ||
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. |
| Expandir | ||
|---|---|---|
| ||
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:
|
| Expandir | ||
|---|---|---|
| ||
As APIs disponibilizadas no Swagger utilizam o Basic Authentication, que é o sistema de autenticação mais comum no protocolo HTTP. Para isso, basta acessar o TOTVS Educacional | Customização | Parâmetros Gerais, conforme imagem abaixo: Na tela que se abrirá, existe um processo "Gerar Token". Nele, será solicitado o usuário e senha para login no TOTVS Educacional, que será utilizado para a autenticação nas APIs disponibilizadas. Ao finalizar a execução do processo, o Token será gerado no campo "Basic Auth", no formato Basic xxxxxxxx, conforme imagens abaixo:
O token deverá ser enviado em todas as requisições no cabecalho HTTP "Authorization". Nos tópicos abaixo serão apresentados exemplos de utilização via POSTMAN e via código em diferentes linguagens. |
| Informações | |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||
|
Import HTML Content
Visão Geral
Conteúdo das Ferramentas