Esse guia tem como objetivo gerar ou atualizar as documentações das API's Service em formato REDOC

Guia passo a passo

Documentação da API é disponibilizada no link correlato: http://{hostname}:8084/{nome-projeto}/swagger-ui.html

Adicione as etapas envolvidas:

1. Passo: Ter instalado o Node
       https://nodejs.org/en/download/
       - Após instalar verificar no terminal se os seguintes comandos funcionam:
           > node -v
           > npm -v
2. Passo: Instalar o redoc-cli com o npm
       > npm i -g redoc-cli
3. Passo: Gerar o redoc 
       - Abrir o terminal se e inserir o seguinte comandos:
           > redoc-cli build [url_origem] --o [destino]
   Exemplo: redoc-cli build http://10.51.12.97:40003/pix-qrcode/v3/api-docs --o C:\Users\jefferson.palermo\Documents\pix-qrcode\pix-qrcode.html
   Obs: Tem que apontar a url de origem para um serviço que esteja rodando
   
   
   
   

Artigos relacionados

Os artigos relacionados aparecem aqui baseados nos rótulos que você selecionar. Clique para editar a macro e adicionar ou alterar os rótulos.