Pular para o conteúdo principal

Primeiro Dia Documentando ComedyHub

· Leitura de 3 minutos
Lucas Macedo
Lucas Macedo
Software Developer

Resumo do Dia​

No primeiro dia de documentação do projeto ComedyHub, foquei em tarefas relacionadas à estruturação da API, refatoração de código e implementação de novas funcionalidades. Abaixo estão os detalhes das atividades realizadas, os próximos passos e os desafios encontrados.

Atividades Realizadas​

1. Implementar Retorno do UserFolder​

  • Objetivo: Adicionar um retorno estruturado para o userfolder, que incluirá:
    • Nome do usuário
    • Quantidade de memes
    • Visibilidade
    • Data de criação
    • Autor do conteúdo

2. Refatoração: Mudar UserFolder para Collection​

  • Objetivo: Realizar uma refatoração no código, alterando o conceito de UserFolder para Collection. Isso deve garantir uma maior consistência e organização no sistema.

3. Separar Enums de Dentro das Classes​

  • Objetivo: Extrair os enums que estão atualmente implementados dentro das classes para arquivos e locais separados, melhorando a modularização do código.

4. Visibilidade das Collections​

  • Objetivo: Implementar controles de visibilidade das collections. Isso deve permitir que as coleções possam ser visíveis ou privadas, de acordo com as permissões definidas.

5. Adicionar Comentários nas Coleções​

  • Objetivo: Incluir uma funcionalidade para que as coleções possam receber comentários. Isso permitirá que os usuários interajam com as coleções, oferecendo feedback ou discutindo seu conteúdo.

6. Organização da API​

  • Objetivo: Melhorar a estrutura e organização da API para que ela siga um padrão similar ao de microsserviços. Isso envolve refatorações em endpoints e na arquitetura da API.

7. Restrições no Cargo do Usuário​

  • Objetivo: Impedir que um usuário altere o próprio cargo. Esse tipo de controle de permissão deve ser implementado para garantir a integridade do sistema de roles.

Próximos Passos​

  • Finalizar a implementação do retorno estruturado do UserFolder.
  • Concluir a refatoração de UserFolder para Collection.
  • Testar a funcionalidade de visibilidade das coleções.
  • Implementar a funcionalidade de comentários nas coleções.
  • Revisar e ajustar a organização da API para garantir que siga o padrão de microsserviços.
  • Validar as restrições de cargo do usuário e garantir que não haja brechas de segurança.

Dúvidas e Desafios​

  • Qual a melhor forma de implementar a funcionalidade de comentários para garantir escalabilidade e performance?
  • Como validar se a organização da API está seguindo corretamente o padrão de microsserviços?
  • Como garantir que as restrições de cargo sejam aplicadas de forma eficiente e segura?

Conclusão​

O primeiro dia de documentação do ComedyHub foi focado em melhorias estruturais e na implementação de novas funcionalidades. As tarefas realizadas ajudaram a organizar melhor o código e a planejar as próximas etapas do projeto. Estou confiante de que as mudanças trarão maior consistência e usabilidade ao sistema.