Swagger: melhores abordagens para documentação

Definição da melhor abordagem para utilização do Swagger em aplicações Node.js

OBJETIVO

Implementar Swegger para geração de documentação.

JUSTIFICATIVA

Adequar a documentação das APIs desenvolvidas em Node.js oferecendo ambiente de teste de requisições, exemplos de retorno e dicionário de dados.

RESULTADOS ESPERADOS

Durante o estudo testamos diversas bibliotecas de geração de documentação, sendo escolhida a routing-controller-openapi por diversos fatores, sendo eles:

• Simplicidade
• Facilidade de implementação
• Facilidade de manutenção
• Pouca poluição do código
• Compatibilidade com as estrategias usadas atualmente  

ENVOLVIDOS:

• Assessor:
  • Diego Gonçalves de Almeida
• Equipe Técnica:
  • Diego Barros de Oliveira
  • Alef Carvalho da Silva
  • Anderson Soares Cardoso
• Gerente de Desenvolvimento:
  • Janderson de Castro Thomaz
• Product Owner:
  • Jônatas Justiniano Lima
• Scrum Master:
  • Edson Masami Hiraçaka

 

GLOSSÁRIO

• PostGreSql- Banco de Dados relacional openSource com mais de 30 anos de desenvolvimento ativo;

 

DESENVOLVIMENTO

....

 

CONCLUSÃO

Realizada a análise e os testes com o banco PostgreSQL no sistema Atualização Cadastral, foi possível prever e implementar no ambiente local do sistema o PostgreSQL. Sendo o passo-a-passo especificado nos tópicos acima. Foram identificados algumas possíveis alterações em tipos de dados, instalação de pacotes do PostgreSql nos sistemas, alteração do banco em código e alteração de connectionString nos ambientes. Estimando-se, um total de 6 pontos para a alteração em cada sistema proposto.

 

REFERÊNCIAS

[1] MICROSOFT. DATA TYPES. 2019. Disponível em: Tipos de dados (Transact-SQL) - SQL Server | Microsoft Docs.  Acesso em: 31 mai. 2021.

 

[2] POSTGRESQL. TIPOS DE DADOS (TRANSACT-SQL). 2020. Disponível em: PostgreSQL: Documentation: 9.6: Data Types.  Acesso em: 31 mai. 2021.

 

[3] POSTGRESQL. Npgsql Entity Framework Core Provider. 2019. Disponível em: Npgsql Entity Framework Core Provider | Npgsql Documentation.  Acesso em: 31 mai. 2021.

 

[4] POSTGRESQL. PostgreSQL Downloads. 2019. Disponível em: PostgreSQL: Documentation: 9.6: Data Types.  Acesso em: 31 mai. 2021.