README.md

API_Central_de_Erros

ErrorMonitoring

Índice

• Objetivo
• Arquitetura
• Tecnologias e Ferramentas Utilizadas
• Banco de Dados
• Deploy da aplicação
• Rotas
• Mais informações
• Squad desenvolvedora
• Agradecimentos

Objetivo

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 implementamos um sistema para centralizar registros de erros de aplicações, através de uma API.

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

Tecnologias Utilizadas:

• C# .NET Core
• Entity Framework Core
• DDD
• Clean Code
• SOLID
• Azure
• Swagger

Ferramentas Utilizadas:

• Visual Studio
• Postman
• Trello
• WhatsApp

Banco de Dados:

• SqlServer via Codefirst

Deploy da aplicação:

• Deploy automático Azure Clique aqui

Rotas:

• AuthController
  POST /api/v1/Auth/cadastrar - Cadastra um novo usuário
  POST /api/v1/Auth/login - Realiza login do usuário cadastrado
  POST /api/v1/Auth/logout - Realiza o logout do usuário
  POST /api/v1/Auth/forgotPassword - Envia um codigo para que o usuário possa resetar a senha
  POST /api/v1/Auth/resetPassword -
  

• EnvironmentController
  GET api/environments - Retorna todos os ambientes da ErrorMonitoring
  GET api/environments/{id} - Retorna o ambiente do ID
  POST api/environments - Cadastra um novo ambiente
  PUT api/environments/{id} - Atualiza o ambiente do ID
  DELETE api/environments/{id} - Deleta o ambiente do ID
  

• ProjectController
  GET api/project - Retorna todos os projetos da ErrorMonitoring
  GET api/project/{id} - Retorna o projeto do ID
  POST api/project - Cadastra um novo projeto
  PUT api/project/{id} - Atualiza o projeto do ID
  DELETE api/project/{id} - Deleta o projeto do ID
  

• EventsController
  GET /api/Events - Retorna todos os eventos da ErrorMonitoring
  GET /api/Events/{id} - Retorna o evento do ID
  POST /api/Events - Cadastra um novo evento
  PUT /api/Events/{id} - Atualiza o evento
  DELETE /api/Events/{id} - Deleta o evento do ID
  

• LogController
  GET api/log - Retorna todos os logs da ErrorMonitoring
  GET api/log/{id} - Retorna o log do ID
  POST api/log - Cadastra um novo log
  PUT api/log/{id} - Atualiza o log do ID
  DELETE api/log/{id} - Deleta o log do ID
  

• ProjectsEnvironments
  GET api/projects_environments - Retorna todos os ambientes e projetos relacionados da ErrorMonitoring
  GET api/projects_environments/{id} - Retorna o ambiente e projeto relacionados do ID
  POST api/projects_environments - Cadastra um novo ambiente e projeto relacionados
  PUT api/projects_environments - Atualiza o ambiente e projeto relacionados do ID
  DELETE api/projects_environments/{id} - Deleta o ambiente e projeto relacionados do ID
  

Maiores informações:

• Esta API é um projeto desenvolvido para o AceleraDev C# Woman ClearSale, um projeto da Codenation.

Squad desenvolvedora:

• Aline Saouda

• Bruna Stefani Marques

• Juliana Onofrio Marques

• Thalita Mariano

Agradecimentos: