Table de conteúdo

1. Iniciando a aplicação
   1.1 Dependencias
   1.2 Executando aplicação
   
2. Funcionalidades
   2.1 Visualizar diferenças no navegador
   2.2 Exportar resultado para CSV
   2.3 Compartilhar resultado via link url
   2.4 Visualizar diferenças através de comparador de arquivos
   

1. Iniciando a aplicação

1.1 Dependencias

• docker https://docs.docker.com/engine/install/
• docker-compose https://docs.docker.com/compose/install/

1.2 Executando aplicação

docker-compose up

Aplicação disponível em: localhost:9000

2. Funcionalidades

2.1 Visualizar diferenças no navegador

• Compara arquivos do tipo OpenAPI no formato yml ou yaml
  • Os arquivos devem ser publicos e disponiveis atraves de um link url no qual será utilizado para realizar a comparação.
• Disponibiliza template para descrição dos itens encontrados com o tipo adicionado, alterado e removido.
• Agrupa os resultados por endpoint e cria uma sessão para alterações realizadas fora do escopo dos endpoints.
• Contabiliza quantidade de itens adicionados, removidos ou alterados.
• A aplicação gera os seguintes detalhes:
  • Caminho
  • O que foi alterado
  • Tipo da Alteração
  • Antes
    • Existe um limitador de 130 caracteres no modo de visualização no navegador. Para ver o detalhamento completo, siga exportando o resultado para csv.
  • Depois
    • Existe um limitador de 130 caracteres no modo de visualização no navegador. Para ver o detalhamento completo, siga exportando o resultado para csv.

imagem: formuário de preenchimento das urls para serem comparadas


imagem: resultado das diferenças agrupados por endpoint


imagem: resultado da diferença em detalhes

2.2 Exportar resultado para CSV

Aplicação cria arquivo do tipo csv com todos os detalhes da comparação dos arquivos.

image: arquivo csv exportado

2.3 Compartilhar resultado via link url

Ao colar a url gerada no navegador, aplicação consegue gerar changeLog com os paramentros configurados de onde a url foi criada. Isso pode facilitar em um momento de analise, no qual precisa de compartilhar um determinado resultado com outras pessoas. Aplicação ao ser requisitada pela url compartilhada, gera novamente o changelog com os mesmos parametros solicitados.

imagem: opção para compartilhar resultado via link url


imagem: Disponibilização do link url para compartilhamento

2.4 Visualizar diferenças através de comparador de arquivos

imagem: opção para visualizar diferenças através de comparador de arquivos


image: diferença entre as vesões