Páginas filhas
  • WebAPI - Documentação do Swagger e consumo de API's

Versões comparadas

Chave

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

Visualizar documentação do Swagger

Síntese

Índice

       

Índice
exclude.*ndice

Objetivo

Orientar o usuário quanto à configuração do ambiente para visualizar documentação do Swagger e permitir testes nas APIs existentes.


Expandir
titleAjustando ambiente

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


Image Modified

Image Modified



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
titleVisualizando a Documentação

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:

Image Removed

).


Para verificar a porta, acesse, através do IIS, o Website "FrameHTML", que é gerado quando realizada a instalação do Portal RM:

Image Added


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".

Image Added


Ao acessar o Swagger, serão listados todos os serviços disponíveis, com a descrição do serviço, parâmetros e urls:


Image Added




Informações
iconfalse
Informações
iconfalse

Produto: Customizações

Informações
iconfalse

Versão: 12.1.17 ou Superiores

Data: 

Informações
iconfalse
titleAutores

Ana Carolina Eleutério Abras

Pedro Antonio Silva Barroso