DEAITOOLS-82 DT Melhorar performance na renderização de APIs grandes

01. DADOS GERAIS

02. SITUAÇÃO/REQUISITO

Foi identificado que, durante a renderização de APIs grandes no portal do API Reference, uma forte lentidão era sentida pelo usuário ao realizar scroll-down na página.

03. SOLUÇÃO

Mecanismo que observa o evento de scroll foi modificado, de modo que ele só se faz necessário agora para previnir que o menu lateral entre no footer da página. A funcionalidade do scrollspy está agora funcionando por meio de biblioteca externa, melhorando muito o desempenho das páginas de detalhes das APIs.

As responses e requests agora já são carregadas de maneira colapsada, de modo que, caso o usuário queira saber maiores detalhes sobre aquelas requests e responses, ele deverá clicar nos novos botões para mostrar esses conteúdos. Essa medida também teve impacto positivo na performance da página.

04. RESULTADOS

Após a implementação das melhorias, foram comparados dois cenários: um com a versão anterior e outro com a nova versão. Os gráficos abaixo foram gerados utilizando a ferramenta Profiler do Chrome. Mostram a redução de tempo na carga das 3 APIs informadas na issue. No servidor jv-fwk-dev01 executou-se a versão anterior aos ajustes. No servidor api.totvs.com.br executou-se a versão com melhorias.

05. INFORMAÇÕES ADICIONAIS

• • Corrigido bug em que a navbar superior tampava o título do endpoint, quando o usuário clicava em um dos itens do menu lateral.
  • Corrigido bug na janela de exemplos das request, onde o portal quebrava quando havia um put/post com request body vazio e o usuário clicava na aba "Java".
  • Corrigido quebra de layout quando o título da response era muito grande. Agora o conteúdo é colapsado e aparece por inteiro caso o usuário passe o mouse.