Ir para o conteúdo principal

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

ENVOLVIDOS

    1.

    Objetivo
    Data
    de
    elaboração
    19/09/22
    Responsável
  • pelo estudo
  • Gabriel Santi Binda

  • Raissa de Sousa Stolduski


  • Taillon Miguel GonçGonçalves
  • Vinicius da Rosa Pereira

  • Á
    Ádelle CamarãCamarão Monteiro
  • Equipe do estudo Tambakiss
    Alvo Gov.Doc API
    Origem

    OMelhoria objetivona destepadronização estudoe éotimização analisardos endpoints do Gov.Doc API

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

     

    Observações

    2.1. IntroduçãIntrodução

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

    3.2. Desenvolvimento

    3.2.1 Serviç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


    4.3. ConclusãConclusão

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

    image.png

     Nos seguintes serviçserviços:

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