Histórico da Página
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
- 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 - Passo: Instalar o redoc-cli com o npm
> npm i -g redoc-cli - 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
Informações |
---|
Referências https://medium.com/@felipe.cobello/criar-um-portal-do-desenvolvedor-com-redoc-7963617e6dcb |
Artigos relacionados
Propriedades de página | ||
---|---|---|
| ||
|
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas