Histórico da Página
Visualizar documentação do Swagger
Síntese
Índice
| Índice | ||
|---|---|---|
|
Objetivo
Orientar o usuário quanto à configuração do ambiente para visualizar documentação do Swagger e permitir testes nas APIs existentes.
| 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. |
Visualizando Documentação
No servidor, digite no browser o caminho do| 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 |
A documentação será exibida conforme imagem abaixo:
). 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:
|
| Informações | |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||
|
Import HTML Content
Visão Geral
Conteúdo das Ferramentas