felipegaleao / fast-api-kafka

📑 Aplicação para escrever em tópicos do Kafka através de uma requisições HTTP usando FastAPI

Maycon Felipe Mota FelipeGaleao

Data & Software Engineering

Graduando em Engenharia de Software pela Universidade Federal do Mato Grosso do Sul (UFMS), tem experiência em projetos de Desenvolvimento Web (React, Angular, Node, PHP e .Net Core), Business Intelligence (Tableau, PowerBI, QlikSense e SuperSet) e Engenharia de Dados (Azure, Google Cloud Plataform).

---

Detalhes

• 📱 Sr Engenheiro de Dados & Tech Lead (Renováveis/Power) na raizen
• ⚛️ Software Engineering Manager no projetomedalha.org
• 👷🏽‍♂️ Cursando Engenharia de Software (2021-2024) na Universidade Federal do Mato Grosso do Sul

---

Experiências

• 💼 Engenheiro de Dados (Tech Lead) na Raízen (2021-)
• 💼 Desenvolvedor Full-Stack (Node, .Net Core, PHP, Angular e React) na Keyrus (2020-2021)
• 💼 Analista de Dados Pleno (Superset, QlikSense, SSIS, SQL Server, Knime) na Secretaria de Fazenda do Mato Grosso do Sul (2020-2020)
• 🚀 Estagiário (PHP, React, Node, Python, Knime, PowerBI, SQL Server) no Grupo Energisa (2019-2020)

---

Cursos/Certificações

• 🏅 Azure Data Fundamentals (DP900) by Microsoft
• 🏅 Academy Accreditation - Databricks Lakehouse Fundamentals by Databricks
• 🏅 Building Batch Data Pipelines on GCP by Google and Coursera
• 🏅 Modernizing Data Lakes and Data Warehouses by Google and Coursera
• 🏅 Google Cloud Platform Big Data and Machine Learning Fundamentals by Google and Coursera
• 🏅 Delta Lake Essentials, Unified Data Analytics Essentials, Fundamentals of Big Data and Apache Spark Associate Developer by Databricks

fast-api-kafka's Issues

[SUGESTÃO] Melhoria na mensagem do consumer

💡 Sugestão

Olá! Gostaríamos de compartilhar uma sugestão para o nosso software.

💭 Descrição da Sugestão

Atualmente, a mensagem de log do consumer é bastante genérica e não fornece informações significativas sobre o que está acontecendo no sistema. Isso pode dificultar a detecção de problemas e tornar a depuração mais difícil, especialmente em ambientes complexos com muitos consumidores.

✔️ Benefícios

• Sugestão de melhoria: Adicionar informações mais detalhadas na mensagem de log do consumer, incluindo:
• O nome do tópico Kafka que está sendo processado pelo consumer.
• O número da partição do tópico que está sendo processada.
• O offset atual sendo processado pelo consumer.
• O registro específico que foi consumido e processado pelo consumer, incluindo o conteúdo dos dados.

⚠️ Impactos Adicionais

Com essas informações adicionais na mensagem de log do consumer, os desenvolvedores podem diagnosticar problemas de forma mais rápida e precisa, bem como entender melhor o comportamento do sistema em diferentes situações. Além disso, os logs mais detalhados podem ajudar a identificar possíveis gargalos de desempenho e outras áreas que possam ser otimizadas para melhorar a eficiência do sistema como um todo.

ℹ️ Informações Adicionais

• Versão do software: v1.0.0
  Agradecemos pela atenção e esperamos por sua avaliação dessa sugestão!

[BUG] Endpoint de editar usuário não está funcionando

🐛 Report de Bugs

Olá! Encontramos um bug no nosso software e gostaríamos de reportá-lo para que possa ser corrigido o mais rápido possível.

🔎 Descrição do Bug

O Endpoint de edição de usuário está funcionando de maneira incorreta ao clicar na aba de configurações e tentar editar perfil.

💭 Comportamento Esperado

Ao clicar em "Editar perfil" o usuário deve ser capaz de editar suas informações, por exemplo, alterar a foto de perfil.

💭 Comportamento Atual

O usuário não consegue alterar informações básicas como a sua foto de perfil

ℹ️ Informações Adicionais

• Versão do software: v1.0.0
• Agradecemos pela atenção e estamos à disposição para qualquer esclarecimento adicional.

[BUG] Endpoint "cadastro_matricula" não está funcionando

🐛 Report de Bugs

Olá! Encontramos um bug no nosso software e gostaríamos de reportá-lo para que possa ser corrigido o mais rápido possível.

🔎 Descrição do Bug

O Endpoint "cadastro_matricula" não está funcionando, ao tentar cadastrar um novo usuário o programa não salva o novo usuário no banco

💭 Comportamento Esperado

O Endpoint deve adicionar o usuário ao banco assim que o cadastro for finalizado

💭 Comportamento Atual

O Endpoint não adiciona o usuário ao banco

[Descreva aqui o comportamento atual que está diferente do esperado.]

ℹ️ Informações Adicionais

• Versão do software: v1.0.0
• Agradecemos pela atenção e estamos à disposição para qualquer esclarecimento adicional.

[SUGESTÃO] Criar endpoint para salvar cadastro de matrículas de alunos

💡 Sugestão

Olá! Gostaríamos de compartilhar uma sugestão para o nosso software.

💭 Descrição da Sugestão

Prezados, sugerimos a criação de um novo endpoint para cadastrar matrículas de alunos no sistema. Espera-se que seja recebido um objeto contendo informações como nome do aluno, número de matrícula, curso, disciplinas e período letivo. É importante que o endpoint valide as informações recebidas antes de efetuar o cadastro no banco de dados. Seria interessante também retornar uma mensagem informando se a matrícula foi realizada com sucesso ou não.

✔️ Benefícios

Irá ajudar na automatização do processo de matrícula de alunos e facilitar o trabalho dos funcionários responsáveis pelo cadastro.

⚠️ Impactos Adicionais

É necessário garantir que as informações enviadas para o endpoint estejam corretas e completas, para evitar erros de cadastro no banco de dados.

ℹ️ Informações Adicionais

• Versão do software: v1.0.0
  Agradecemos pela atenção e esperamos por sua avaliação dessa sugestão!

[SUGESTÃO] Criar uma documentação sobre como subir o projeto

💡 Sugestão

Olá! Gostaríamos de compartilhar uma sugestão para o nosso software.

💭 Descrição da Sugestão

Uma sugestão para melhorar a documentação de um projeto seria criar uma guia "Getting Started" (Começando) que descreva as etapas iniciais para começar a trabalhar no projeto. Isso pode incluir informações como instalação de dependências, configuração do ambiente e outras instruções essenciais.

Além disso, é importante garantir que a documentação seja clara e fácil de seguir. Use exemplos concretos sempre que possível e forneça imagens ou capturas de tela para ilustrar conceitos mais complexos.

Também é útil organizar a documentação por tópicos e fornecer um índice ou tabela de conteúdo para facilitar a navegação. Isso ajudará os usuários a encontrar rapidamente as informações relevantes que eles precisam.

Finalmente, certifique-se de revisar e atualizar regularmente a documentação para garantir que ela esteja sempre precisa e atualizada.

✔️ Benefícios

Uma documentação fácil de entender e seguir pode trazer inúmeros benefícios para um projeto, tais como:

• Redução do tempo de aprendizado: Com uma documentação clara e concisa, os usuários podem se familiarizar rapidamente com o projeto e começar a usá-lo mais rapidamente.
• Melhoria na colaboração: Uma documentação bem organizada e fácil de acessar também facilita a colaboração entre membros da equipe, pois todos têm acesso às mesmas informações.
• Diminuição de erros: A documentação detalhada ajuda a minimizar erros que podem surgir durante o desenvolvimento ou uso do projeto, já que os usuários têm acesso a informações precisas e atualizadas.
• Maior adoção do produto: Quando a documentação é fácil de usar, isso pode encorajar mais pessoas a experimentarem o produto, aumentando assim sua adoção e popularidade.
• Facilidade para resolução de problemas: Em caso de problemas, uma documentação clara pode ajudar os usuários a diagnosticar e resolver problemas com mais rapidez.
• Menos dúvidas e perguntas: Quando a documentação é completa e fácil de entender, os usuários têm menos dúvidas e, consequentemente, fazem menos perguntas para a equipe de suporte técnico.
  Esses benefícios ajudam a melhorar a eficiência do projeto e, por consequência, aumentam a satisfação dos usuários e da equipe envolvida no projeto.

⚠️ Impactos Adicionais

Não tenho ideia sobre um possível impacto adicional

ℹ️ Informações Adicionais

• Versão do software: Versão 1.0.0

Agradecemos pela atenção e esperamos por sua avaliação dessa sugestão!

[SUGESTÃO] Exemplificação para implementação

💡 Sugestão

Olá! Gostaríamos de compartilhar uma sugestão para o nosso software.

💭 Descrição da Sugestão

Gostaria de sugerir, que hajam exemplos mais claros como a utilização de mockups para facilitar a implementação do código

✔️ Benefícios

• Aumenta a coesão entre os requisitos e o produto final
• Facilita na lógica durante a implementação
• Pode ser utilizado para manter a coesão entre o que o cliente espera e o produto final

Implementação 🔧

• Criar um projeto no figma
• Atualiza-lo com as paginas que já foram implementadas
• Atualiza-lo sempre que for acordado a implementação de uma nova página

⚠️ Impactos Adicionais

• Otimiza o tempo de implementação

ℹ️ Informações Adicionais

• Versão do software: v1.0.0
  Agradecemos pela atenção e esperamos por sua avaliação dessa sugestão!

[SUGESTÃO] Adicionar documentação de requisitos do sistema

💡 Sugestão

Olá! Gostaríamos de compartilhar uma sugestão para o nosso software.

💭 Descrição da Sugestão

Precisamos criar uma documentação clara e objetiva sobre os requisitos do nosso sistema. Esses requisitos podem ser retratados de diferentes formas como: "Histórias de Usuário", "Critérios de Aceitação", "Casos de Uso", entre outros.

✔️ Benefícios

• Clareza e compreensão das regras e definições sistêmicas
• Base clara para o desenvolvimento
• Mapeamento e gerenciamento de mudanças
• Base para testes e validação

⚠️ Impactos Adicionais

Acredito que teremos que contratar um profissional especializado para documentar todas as regras do sistema.

ℹ️ Informações Adicionais

• Versão do software: v1.0.0
  Agradecemos pela atenção e esperamos por sua avaliação dessa sugestão!

[SUGESTÃO] Adicionar fluxo aos mockups do figma

💡 Sugestão

Olá! Gostaríamos de compartilhar uma sugestão para o nosso software.

💭 Descrição da Sugestão

Acredito que seja de grande importância adicionar fluxo aos mockups do figma.

✔️ Benefícios

• Aumenta a coesão dos mockups
• Exemplifica de maneira mais clara a funcionalidade de cada parte do projeto

Implementação 🔧

• Adicionar fluxo aos botões do protótipo

⚠️ Impactos Adicionais

• Mantém a equipe mais coesa
• Diminui a ambiguidade

ℹ️ Informações Adicionais

• Verificar se o fluxo está de acordo com as telas já criadas e com a documentação

• Versão do software: v1.0.0
  Agradecemos pela atenção e esperamos por sua avaliação dessa sugestão!

[SUGESTÃO] Criar documentação sobre as Stacks utilizadas no projeto

💡 Sugestão

Olá! Gostaríamos de compartilhar uma sugestão para o nosso software.

💭 Descrição da Sugestão

Meus bacanas, poderíamos criar uma documentação com as Stacks que utilizamos no nosso projeto e o motivo de utilizarmos cada uma delas.

✔️ Benefícios

• Compartilhamento de conhecimento
• Transparência e comunicação com nossos usuários

⚠️ Impactos Adicionais

Apenas impactos positivos para o projeto.

ℹ️ Informações Adicionais

• Versão do software: v1.0.0
  Agradecemos pela atenção e esperamos por sua avaliação dessa sugestão!

[SUGESTÃO] Modelo de severidade e/ou prioridade

💡 Sugestão

Olá! Gostaríamos de compartilhar uma sugestão para o nosso software.

💭 Descrição da Sugestão

No repositório não há modelo de severidade, sugiro utilizarmos a escala: Low, Medium e High nas issues, assim, definindo as Tags e severidade da mesma.

✔️ Benefícios

• Priorização de problemas.
• Comunicação clara.
• Tomada de decisões.
• Transparência e rastreabilidade.
• Melhoria contínua.

Implementação 🔧

Para a implementação deste modelo de severidade usaremos:

• Low: Problemas de baixa severidade que têm um impacto mínimo no funcionamento do sistema.
• Medium: Problemas que têm um impacto moderado no sistema ou em um grupo específico de usuários.
• High: Problemas críticos que afetam diretamente a funcionalidade principal do sistema, causando interrupção ou perda de dados.

⚠️ Impactos Adicionais

Ao atribuir uma severidade aos problemas, há uma maior responsabilidade e prestação de contas para a equipe de desenvolvimento em relação à resolução desses problemas. Isso cria um ambiente em que os membros da equipe são incentivados a tomar medidas para resolver as questões de maior gravidade e garantir a qualidade do software.

ℹ️ Informações Adicionais

• Versão do software: v1.0.0
  Agradecemos pela atenção e esperamos por sua avaliação dessa sugestão!

[SUGESTÃO] Adicionar documentação sobre arquitetura do sistema

💡 Sugestão

Olá meus amigos! Gostaríamos de compartilhar uma sugestão para o nosso software.

💭 Descrição da Sugestão

Estava dando uma olhada geral em nosso projeto e sinto que precisamos URGENTEMENTE fazer a diagramação e mapeamento da arquitetura que estamos utilizando para o nosso sistema.

✔️ Benefícios

• Comunicação clara entre todos os envolvidos
• Análise de impacto de mudanças
• Manutenção e evolução
• Documentação e compartilhamento de conhecimento

⚠️ Impactos Adicionais

Além dos benefícios citados, teremos que retirar um grande tempo de trabalho de toda a equipe para fazer essa diagramação.

ℹ️ Informações Adicionais

• Versão do software: v1.0.0
  Agradecemos pela atenção e esperamos por sua avaliação dessa sugestão!

[SUGESTÃO] Criar novo endpoint para recuperar dados referentes a matrícula.

💡 Sugestão

Olá! Gostaríamos de compartilhar uma sugestão para o nosso software.

💭 Descrição da Sugestão

Olá amigos, agora que já temos um endpoint para realização do cadastro da matrícula, precisamos de um endpoint para recuperar esses dados do kafta. Sempre verifique se a pessoa que está solicitando essas informações possui as credenciais necessárias para isso.

✔️ Benefícios

Com esse novo endpoint, será possível recuperar informações referentes a matrícula que serão necessárias para o funcionamento do nosso sistema como um todo.

⚠️ Impactos Adicionais

Verificar se a informação que está buscando está no banco para evitar erros ou informações incorretas.

ℹ️ Informações Adicionais

• Versão do software: v1.0.0
  Agradecemos pela atenção e esperamos por sua avaliação dessa sugestão!

[SUGESTÃO] Criar endpoint para receber mensagens de notificações.

💡 Sugestão

Olá! Gostaríamos de compartilhar uma sugestão para o nosso software.

💭 Descrição da Sugestão

Prezados, estamos trabalhando no aplicativo mobile da FACOM, então, se faz necessário criar um novo endpoint para armazenar as notificações no Kafka. Espera-se que seja recebido um objeto contendo mensagem, data, criação e fonte. É necessário que as mensagens sejam publicadas em um novo tópico chamado "notificacoes_facom"

✔️ Benefícios

Irá ajudar na implementação da solução de mensageria no aplicativo mobile da FACOM

⚠️ Impactos Adicionais

Criar um novo endpoint que salva as mensagens no tópico "notificacoes_facom"

ℹ️ Informações Adicionais

• Versão do software: v1.0.0
  Agradecemos pela atenção e esperamos por sua avaliação dessa sugestão!

[SUGESTÃO] Criar endpoint para excluir a requisição acadêmica.

💡 Sugestão

Olá! Gostaríamos de compartilhar uma sugestão para o nosso software.

💭 Descrição da Sugestão

Olá amigos, continuando a discussão da nossa nova funcionalidade de requisição acadêmica já tratada nas issues #31 e #34. Ainda se faz necessária a funcionalidade de exclusão da requisição. Nos casos em que a requisição foi feita de maneira incorreta, precisamos que o acadêmico possa a excluir.

✔️ Benefícios

• Permitir que o acadêmico exclua suas requisições incorretas.

⚠️ Impactos Adicionais

Verificar se o endpoint está recebendo o id correto para realizar a exclusão.

ℹ️ Informações Adicionais

• Versão do software: v1.0.0
  Agradecemos pela atenção e esperamos por sua avaliação dessa sugestão!

[SUGESTÃO] Controle de Versões (Branching model)

💡 Sugestão

Olá! Gostaríamos de compartilhar uma sugestão para o nosso software.

💭 Descrição da Sugestão

O Gitflow é um modelo de fluxo de trabalho para o controle de versão e gerenciamento de branches. Ele utiliza uma estrutura de branches bem definida, com o objetivo de facilitar a colaboração em equipes e promover um desenvolvimento organizado e controlado. O Gitflow utiliza branches principais, como "master" e "develop", além de branches de feature, release, hotfix e support, para gerenciar o ciclo de vida do software, permitindo o desenvolvimento paralelo de novas funcionalidades, correção de bugs e lançamento de versões estáveis.

✔️ Benefícios

• Organização e estrutura clara.
• Separação de funcionalidades.
• Facilidade no gerenciamento de lançamentos.
• Controle de qualidade.
• Resolução eficiente de problemas.
• Integração com ferramentas de CI/CD.

Implementação 🔧

Definir as branches principais, sendo elas: "master" e "develop".

• master: Representa a versão estável e pronta para produção.
• develop: Utilizada para o desenvolvimento contínuo do software.

Para cada nova funcionalidade a ser desenvolvida, crie uma nova branch de feature a partir da branch "develop". Nomeie a branch de forma descritiva, relacionada à funcionalidade que está sendo implementada.
Quando for necessário preparar uma nova versão estável para o lançamento, crie uma branch de release a partir da branch "develop". Nessa branch, corrija eventuais bugs e faça os ajustes finais para a versão de lançamento.
Caso ocorram bugs críticos ou problemas em produção, crie uma branch de hotfix a partir da branch "master". Corrija o problema na branch de hotfix e faça um merge tanto na branch "master" quanto na branch "develop" para garantir que a correção seja aplicada em ambas.

⚠️ Impactos Adicionais

• Controle de qualidade.
• Rastreabilidade e histórico claro.
• Facilidade no lançamento de versões.

ℹ️ Informações Adicionais

• Versão do software: v1.0.0
  Agradecemos pela atenção e esperamos por sua avaliação dessa sugestão!

[SUGESTÃO] Criar endpoint de cadastrar professor

💡 Sugestão

Olá! Gostaríamos de compartilhar uma sugestão para o nosso software.

💭 Descrição da Sugestão

Este endpoint é responsável por cadastrar um novo professor no sistema. O cadastro de professor requer o envio dos dados necessários para criar um novo registro de professor, como nome, email, especialização, entre outros.

✔️ Benefícios

• Consistência de dados.
• Rastreabilidade.
• Separação de responsabilidades.

Implementação 🔧

Parâmetros de entrada:

• name (string): O nome completo do professor.
• email (string): O endereço de email do professor.
• specialization (string): A especialização ou área de atuação do professor.

Resposta de Sucesso:
Caso o professor seja cadastrado com sucesso, o endpoint retornará o código de status HTTP 201 (Created) juntamente com os dados do professor cadastrado.

ℹ️ Informações Adicionais

• Versão do software: v1.0.0
  Agradecemos pela atenção e esperamos por sua avaliação dessa sugestão!

[SUGESTÃO] Alterar tipo dos atributos ID para INT

💡 Sugestão

Olá! Gostaríamos de compartilhar uma sugestão para o nosso software.

💭 Descrição da Sugestão

Meus queridos, acredito que seja melhor tratarmos os IDs dos nossos objetos e classes como um dado inteiro.

✔️ Benefícios

• Eficiência de armazenamento
• Eficiência de pesquisa e indexação
• Integridade de dados
• Facilidade de cálculos e comparações

⚠️ Impactos Adicionais

Se realmente formos fazer essa alteração, precisamos ter extremo cuidado, pois, essa alteração irá gerar impacto em toda a nossa aplicação.

ℹ️ Informações Adicionais

• Versão do software: v1.0.0
  Agradecemos pela atenção e esperamos por sua avaliação dessa sugestão!

[BUG] Atualizar documentação do READ.ME do projeto

🐛 Report de Bugs

Olá! Encontramos um bug no nosso software e gostaríamos de reportá-lo para que possa ser corrigido o mais rápido possível.

🔎 Descrição do Bug

No READ.ME do projeto, na seção de "Documentação", existem 3 tópicos listados: "Commits Semânticos", "Modelo de Ramificação" e "Modelo de Severidade". Porém, quando analisamos todas as documentações do repositório, não possuem apenas essas 3 citadas.

💭 Comportamento Esperado

Listar as seguintes documentações:

• Commits Semânticos
• Guia inicial
• Informações de Classe
• Informações da Classe Matrícula
• Modelo de Ramificações
• Modelo de Severidade

💭 Comportamento Atual

Está listando apenas essas 3 documentações:

• Commits Semânticos
• Modelo de Ramificações
• Modelo de Severidade

📷 Screenshots

ℹ️ Informações Adicionais

• Versão do software: v1.0.0
• Agradecemos pela atenção e estamos à disposição para qualquer esclarecimento adicional.

[BUG] Requisição não está salvando no Kafka

🐛 Report de Bugs

Olá! Encontramos um bug no nosso software e gostaríamos de reportá-lo para que possa ser corrigido o mais rápido possível.

🔎 Descrição do Bug

Ao tentar salvar uma requisição no Kafka, o sistema não está conseguindo realizar a operação com sucesso. Após preencher todos os campos necessários e clicar em "Salvar", a seguinte mensagem de erro é exibida: "Não foi possível salvar a requisição no Kafka".

💭 Comportamento Esperado

A requisição deve ser salva com sucesso no Kafka após receber a requisição

💭 Comportamento Atual

A requisição não está sendo salva no Kafka

• Versão do software: v1.0.0
• Agradecemos pela atenção e estamos à disposição para qualquer esclarecimento adicional.

[SUGESTÃO] Criar endpoint para criação de requisição acadêmica.

💡 Sugestão

Olá! Gostaríamos de compartilhar uma sugestão para o nosso software.

💭 Descrição da Sugestão

Olá amigos, acredito que precisamos de uma nova funcionalidade para o nosso sistema. Precisamos de uma funcionalidade permitindo que um estudante faça uma requisição acadêmica. Essa requisição precisa receber um objeto contendo o tipo de requisição, data, número da matrícula, nome do estudante e a descrição da requisição. Lembrando que precisamos de uma mensagem de retorno confirmando a se a requisição foi feita com sucesso ou não.

✔️ Benefícios

• Permitir que o estudante faça requisições a secretária de curso.
• Diminuir o tempo para conseguir a documentação necessária.
• Trocar informações referentes a matrícula.

⚠️ Impactos Adicionais

Verificar se as informações vindas no endpoint estão corretas e completas, evitando erros cadastro da requisição no banco.

ℹ️ Informações Adicionais

• Versão do software: v1.0.0
  Agradecemos pela atenção e esperamos por sua avaliação dessa sugestão!

[SUGESTÃO] Criar Endpoint "excluir_matricula"

💡 Sugestão

Olá! Gostaríamos de compartilhar uma sugestão para o nosso software.

💭 Descrição da Sugestão

Adicionar endpoint "excluir_matricula" ao código

✔️ Benefícios

• Aumenta o controle sobre o espaço armazenado no banco

Implementação 🔧

• Criar endpoint que exclua matricula do banco

⚠️ Impactos Adicionais

• Ajuda no controle dos usuários do sistema

ℹ️ Informações Adicionais

• Versão do software: v1.0.0
  Agradecemos pela atenção e esperamos por sua avaliação dessa sugestão!

[SUGESTÃO] Controle de Versões (commit semântico)

💡 Sugestão

Olá! Gostaríamos de compartilhar uma sugestão para o nosso software.

💭 Descrição da Sugestão

Conventional Commits é uma convenção para criar mensagens de commit padronizadas e semânticas. Essa convenção visa fornecer um formato consistente e significativo para as mensagens de commit, permitindo que as ferramentas automatizadas interpretem e analisem facilmente as alterações realizadas no código-fonte.

✔️ Benefícios

• Comunicação clara e consistente.
• Facilita a revisão de código.
• Melhoria da colaboração em equipe.
• Facilidade na geração de changelogs.

Implementação 🔧

Escolha um tipo apropriado para o seu commit, indicando o propósito das alterações. Alguns exemplos comuns de tipos são:

• feat: Adição de uma nova funcionalidade.
• fix: Correção de um bug.
• docs: Alterações relacionadas à documentação.
• style: Alterações de formatação, como espaços em branco, indentação, etc.
• refactor: Refatoração do código sem alterar o comportamento.

⚠️ Impactos Adicionais

• Padronização e consistência.
• Melhoria na documentação técnica.
• Pesquisabilidade e navegabilidade.

ℹ️ Informações Adicionais

• Versão do software: v1.0.0
  Agradecemos pela atenção e esperamos por sua avaliação dessa sugestão!

[SUGESTÃO] Adicionar endpoint "editar_matricula"

💡 Sugestão

Olá! Gostaríamos de compartilhar uma sugestão para o nosso software.

💭 Descrição da Sugestão

Adicionar endpoint "editar_matricula"

✔️ Benefícios

• Caso um aluno troque de curso, isso facilitará a troca de curso no banco, pois ao invés de excluir o usuário e adicionar novamente, apenas trocará o curso de um usuário do sistema

Implementação 🔧

• Implementar endpoint que altere dados de uma matricula ja existente no banco

⚠️ Impactos Adicionais

• Torna o código mais rápido e prático

ℹ️ Informações Adicionais

• Versão do software: v1.0.0
  Agradecemos pela atenção e esperamos por sua avaliação dessa sugestão!

[SUGESTÃO] Adicionar informações sobre a classe comprovante de matricula na documentação.

💡 Sugestão

Olá! Gostaríamos de compartilhar uma sugestão para o nosso software.

💭 Descrição da Sugestão

Olá amigos, nos precisamos atualizar nossa documentação sobre as classes. Atualmente a nossa documentação está com informações apenas sobre uma classe. Seria interessante adicionar sobre a classe de comprovante de matricula.

✔️ Benefícios

• Facilitar a entrada de novos desenvolvedores, ajudando e diminuindo o tempo de adaptação com o sistema.
• Teremos um arquivo com as informações sobre as classes mais importantes.

⚠️ Impactos Adicionais

Padronização de como as informações sobre as classes serão guardadas.

ℹ️ Informações Adicionais

• Versão do software: v1.0.0
  Agradecemos pela atenção e esperamos por sua avaliação dessa sugestão!

[SUGESTÃO] Criar endpoint para escrita de mensagens no tópico "Comprovante_de_matriculas" do Kafka.

💡 Sugestão

Olá! Gostaríamos de compartilhar uma sugestão para o nosso software.

💭 Descrição da Sugestão

Pessoal, precisamos de um endpoint para permitir a escrita de mensagens no tópico de "comprovantes_de_matricula" do Kafka. O principal objetivo é armazenar informações referentes à geração de comprovante de matrícula em tempo real, permitindo o monitoramento e análise dessas informações posteriormente.

✔️ Benefícios

A criação deste novo endpoint terá impacto na arquitetura geral do sistema, já que será necessário integrá-lo com outras funcionalidades relacionadas à gestão de matrículas e ao monitoramento e análise das informações geradas. É importante considerar possíveis falhas na comunicação e garantir que nenhuma mensagem seja perdida durante o processo.

Sempre lembrar de Testar o endpoint e garantir o correto funcionamento.

⚠️ Impactos Adicionais

Criar um novo endpoint para escrita de mensagens no tópico "comprovante_horario_ponto"

ℹ️ Informações Adicionais

• Versão do software: v1.0.0
  Agradecemos pela atenção e esperamos por sua avaliação dessa sugestão!

[BUG] Endpoint de salvar comprovante de matícula não está funcionando

🐛 Report de Bugs

Olá! Encontramos um bug no nosso software e gostaríamos de reportá-lo para que possa ser corrigido o mais rápido possível.

🔎 Descrição do Bug

Devido a esse bug, os usuários não conseguem salvar adequadamente o comprovante de matrícula, o que pode levar a problemas futuros, como dificuldades na verificação da documentação necessária ou na recuperação do comprovante em momentos críticos.

💭 Comportamento Esperado

Após clicar em "Salvar" ou "Enviar", o sistema deve processar e salvar o comprovante de matrícula anexado junto com os demais dados preenchidos pelo usuário.

💭 Comportamento Atual

Ao tentar salvar a matrícula, o sistema não registra o comprovante anexado. Apesar de exibir uma mensagem de sucesso na tela, o arquivo de comprovante não é armazenado corretamente no sistema. Ao visualizar os detalhes da matrícula posteriormente, o comprovante não está disponível ou aparece como um link quebrado.

ℹ️ Informações Adicionais

• Versão do software: v1.0.0
• Agradecemos pela atenção e estamos à disposição para qualquer esclarecimento adicional.

[SUGESTÃO] Criar endpoint para recuperar informações da requisição acadêmica.

💡 Sugestão

Olá! Gostaríamos de compartilhar uma sugestão para o nosso software.

💭 Descrição da Sugestão

Olá pessoal, como a issue #31 trata sobre a criação de uma requisição, será necessário também buscar essas informações no Kafta. Por isso, peço que seja criado esse novo endpoint para que não tenhamos problemas para recuperar essas informações depois.

✔️ Benefícios

• Fazer a busca de todas as requisições acadêmicas abertas de maneira rápida.
• Fazer a busca de uma requisição específica.

⚠️ Impactos Adicionais

Verificar se o endpoint está buscando a requisição correta e se a pessoa está com autorização para pedir esses dados.

ℹ️ Informações Adicionais

• Versão do software: v1.0.0
  Agradecemos pela atenção e esperamos por sua avaliação dessa sugestão!

[SUGESTÃO] Melhoria de logs ao receber uma requisição HTTP

💡 Sugestão

Olá! Gostaríamos de compartilhar uma sugestão para o nosso software.

💭 Descrição da Sugestão

Ao receber uma requisição HTTP, o sistema atualmente registra apenas as informações básicas no log, como a data e hora da requisição, o método HTTP utilizado e o status da resposta. No entanto, esses dados não fornecem informações suficientes para diagnosticar com precisão problemas ou entender o comportamento do sistema em detalhes.

✔️ Benefícios

• Adicionar informações adicionais no log ao receber uma requisição HTTP, incluindo:
• Os headers da requisição e da resposta HTTP, incluindo o User-Agent e qualquer outro dado relevante.
• O corpo da requisição e da resposta HTTP, se for o caso.
• O tempo de processamento da requisição, desde o momento em que é recebida pelo servidor até o momento em que a resposta é enviada.

Qualquer erro ou exceção que ocorrer durante o processamento da requisição, juntamente com informações adicionais sobre o erro, como a pilha de chamadas (stack trace) e outros dados relevantes.

⚠️ Impactos Adicionais

Com essas informações adicionais no log, os desenvolvedores podem diagnosticar problemas de forma mais rápida e precisa, bem como entender melhor o comportamento do sistema em diferentes situações. Além disso, os logs mais detalhados podem ajudar a identificar possíveis gargalos de desempenho e outras áreas que possam ser otimizadas para melhorar a experiência do usuário e a eficiência do sistema como um todo.

ℹ️ Informações Adicionais

• Versão do software: v1.0.0
  Agradecemos pela atenção e esperamos por sua avaliação dessa sugestão!

[SUGESTÃO] Criar endpoint para registrar horário de ponto

💡 Sugestão

Olá! Gostaríamos de compartilhar uma sugestão para o nosso software.

💭 Descrição da Sugestão

Se faz necessário criar um novo endpoint para registrar horário de ponto no Kafka. Espera-se que seja recebido um objeto contendo horario, pessoa e unidade. É necessário que as mensagens sejam publicadas em um novo tópico "comprovante_horario_ponto".

✔️ Benefícios

• Registro preciso de horas trabalhadas.
• Gestão de presença e ausência.
• Monitoramento de produtividade.
• Histórico de atividades.

⚠️ Impactos Adicionais

Criar um endpoint para registrar o horário de ponto em um sistema pode trazer diversos benefícios e ter várias finalidades.

ℹ️ Informações Adicionais

• Versão do software: v1.0.0
  Agradecemos pela atenção e esperamos por sua avaliação dessa sugestão!

[SUGESTÃO] Refatorar estrutura de código para DDD

💡 Sugestão

Olá meus companheiros! Gostaríamos de compartilhar uma sugestão para o nosso software.

💭 Descrição da Sugestão

Gostaria de propor que refizéssemos nossa estrutura de código para nos adequar ao DDD (Domain Driven Design). Se orientarmos o nosso desenvolvimento ao domínio da aplicação, teremos mais sucesso na manutenibilidade e no entendimento da solução.

✔️ Benefícios

• Compreensão aprofundada do domínio de todos os desenvolvedores
• Flexibilidade e manutenção
• Separação de responsabilidades
• Orientação a testes
• Melhoria da qualidade do software

⚠️ Impactos Adicionais

Precisamos avaliar o valor dessa sugestão e compararmos o tempo necessário para essa implementação. Isso pode impactar o tempo de trabalho de vários desenvolvedores durante um considerável período de tempo.

ℹ️ Informações Adicionais

• Versão do software: v1.0.0
  Agradecemos pela atenção e esperamos por sua avaliação dessa sugestão!