API - Central de Erros

Aceleração em .Net Core da Codenation em Parceria com ClearSale

Trabalho desenvolvido pela Squad:

• Mariana Tancredi
• Mayara Ferreira
• Sofia Viesti
• Tabatha Macedo

Descrição do projeto

Em projetos modernos é cada vez mais comum o uso de arquiteturas baseadas em serviços ou microsserviços. Nestes ambientes complexos, erros podem surgir em diferentes camadas da aplicação (backend, frontend, mobile, desktop) e mesmo em serviços distintos. Desta forma, é muito importante que os desenvolvedores possam centralizar todos os registros de erros em um local, de onde podem monitorar e tomar decisões mais acertadas. Neste projeto vamos implementar um sistema para centralizar registros de erros de aplicações.

Organização do Projeto

Cada tarefa é documentada em uma issue que será atribuída a um membro do grupo conforme disponibilidade. A issue deverá ser desenvolvida em uma nova branch, criada a partir da master e que tenha em seu nome o ID da issue e uma descrição curta. Ao terminar o desenvolvimento, deverá ser submetido um pull request com a requisição de revisão dos demais membros do grupo. Quando aprovada, a branch será mergeada com a master e a issue será encerrada.

A arquitetura do projeto é formada por:

Backend - API

• criar endpoints para serem usados pelo frontend da aplicação
• criar um endpoint que será usado para gravar os logs de erro em um banco de dados relacional
• a API deve ser segura, permitindo acesso apenas com um token de autenticação válido

Frontend

• deve implementar as funcionalidades apresentadas nos wireframes
• deve ser acessada adequadamente tanto por navegadores desktop quanto mobile
• deve consumir a API do produto
• desenvolvida na forma de uma Single Page Application

Tecnologias Utilizadas

• .NET Core
• Entity FrameWork Core
• Clean Code
• Swagger
• JWT
• Azure

Ferramentas Utilizadas

• Visual Studio
• Trello
• WhatsApp
• Azure
• Heroku
• Asesprite

Banco de dados

• SQLServer criado através do Azure.

Rodar Aplicação

• Digite no gitbash:

git clone https://github.com/mayaracsferreira/error-central

Restaure as dependências, faça o build e rode:

dotnet restore
dotnet build
dotnet run

Acesse a url: https://localhost:5001/swagger/index.html

• Crie o usuário e logue para o obter o token pedido;

bearer {token}

Deploy da Aplicação

O deploy da aplicação foi feito através do Azure.

• API

Demonstração da Aplicação

• Back-end
• Front-end

Rotas

• EventLogController

  • POST /api/EventLog - Cadastra novo erro na Central.
  • GET /api/EventLog - Traz todos os erros ativos cadastrados na Central.
  • GET /api/EventLog/{id} - Traz erro por número de ID
  • PUT /api/EventLog/{id} - Atualizo erro cadastrado
  • DELETE /api/EventLog/{id} - Apaga erro de acordo com o número de ID.
  • GET /api/EventLog/filters/{environment}/{orderBy}/{searchFor}/{field} - Filtra e agrupa os erros de acordo com os filtros selecionados.
  • GET /api/EventLog/groupBy/{environment}/{orderBy} - Agrupa e orderna dados de acordo com os parâmetros recebidos.
  • PUT /api/EventLog/arquivar/{id} - Arquiva erro por ID.

• Login

  • POST /api/login - Realiza o login do usuário

• User

  • GET /api/user - Lista todos os usuários cadastrados.
  • POST /api/user - Adiciona um novo usuário para acesso ao sistema
  • PUT /api/user - Troca a senha do usuário dado seu email e nova senha.

Front-end

Front-end foi desenvolvido por Mayara com a tecnologia Angular.

• Você pode checar aqui!

  
  

Agradecimentos

• Alessandra Soares
• Codenation
• Ingrid Oliveira
• Thamirys Gameiro
• ClearSale
• Jacke Araujo
• Toda Comunidade .Net Girls.

Curiosidades:

• Existe um sistema de automático de envio de emails de Boas vindas após a criação de usuário com email válido;
  desativado no deploy por questões de segurança haha
• Nosso mascote se chama BugHunter;
• Foi criado em Asesprite baseados nas cores da parceira do curso, ClearSale ;

Primeira versão