Ir para o conteúdo principal

[Gov.Doc] Estudo: Esforço para padronizar e otimizar chamadas de API no gov.doc

Data de elaboração 19/09/22
Responsável pelo estudo

Gabriel Santi Binda

Raissa de Sousa Stolduski
Taillon Miguel Gonçalves

Vinicius da Rosa Pereira
Ádelle Camarão Monteiro

Equipe do estudo Tambakiss
Alvo Gov.Doc API
Origem

Melhoria na padronização e otimização dos endpoints do Gov.Doc API

Objetivo Analisar o esforço para padronizar as chamadas de API no sistema do Gov.Doc, como resultado, a refatoração do código.
Documentação correlata (opcional)

 

Observações

1. Introdução

Dentro deste estudo serão identificados quais os serviços possuem padrões de chamadas de API distintos no Gov.Doc, e alinhá-los  para garantir uma arquitetura limpa do sistema. O estudo surgiu a partir da necessidade de poupar tempo e esforço nas futuras manutenções do software.

2. Desenvolvimento

2.1 Serviços a serem alterados

  • App/Services/ApiDeEmail

image.png

  • App/Services/AssineAqui 

image.png

  • App/Services/ApiGovDoc

    image.png

    image.png

    image.png

    image.png

    image.png

    image.png

  • App/Services/DocumentosApiGovDoc

    image.png

    image.png

    image.png

    image.png

    image.png

    image.png

    image.png


3. Conclusão

Foi implementada a Interface IHttpHelpService, seguindo o seguinte padrão:

image.png

 Nos seguintes serviços:

  • App/Services/ApiDeEmail;
  • App/Services/ApiGovDoc;
  • App/Services/AssineAqui;
  • App/Services/DocumentosApiGovDoc.