Mapa de Localizações do Rick and Morty - Backend em C# e .NET 8

📄 Escopo do Projeto

Desenvolvimento de um backend em C# utilizando .NET 9 para um aplicativo que mapeia todas as localizações presentes na série Rick and Morty. O backend fornece uma API RESTful que permite a consulta de informações sobre as localizações, incluindo detalhes como nome, tipo, dimensão e os personagens associados a cada localização. Esse aplicativo também se conecta a api rickandmortyapi.com recebendo e tratando os dados das requisições realizadas.

🚀 Funcionalidades

1. Cadastro de Localizações e Personagens

   • Adicionar novas localizações e personagens.
   • Atualizar informações de localizações e personagens existentes.
   • Deletar localizações e personagens.

2. Consultas sofisticadas

   • Listar todas as localizações e personagens.
   • Buscar localizações e personagens por critérios (nome, tipo, dimensão).
   • Obter detalhes de uma localização ou personagem específico.

3. Associação de Personagens às Localizações

   • Associar personagens a uma localização.
   • Listar personagens associados a uma localização específica.
   • Listar localização e seus personagens.

4. Autenticação e Autorização

   • Implementação de autenticação JWT para segurança dos endpoints.
   • Autorização baseada em roles para controlar o acesso a determinados endpoints (ex.: apenas administradores podem adicionar/atualizar/deletar localizações).

5. Cache

   • Implementação de cache para melhorar a performance das consultas a api externa.
   • Cacheamento de respostas das consultas mais frequentes.

6. Persistência de Dados

   • Utilização do SQLite como banco de dados para persistir informações sobre as localizações e suas associações com personagens.
   • Manter histórico de pesquisa dos usuários

7. Arquitetura Domain Driven Design (DDD)

   • Implementação seguindo os princípios de DDD para organizar e estruturar o código de forma modular e escalável.

🛠 Tecnologias Utilizadas

• .NET 9: Framework principal para desenvolvimento do backend.
• C#: Linguagem de programação.
• Entity Framework Core: ORM para interação com o banco de dados SQLite.
• SQLite: Banco de dados para armazenamento persistente.
• JWT (JSON Web Token): Para autenticação e autorização.
• MemoryCache/Redis: Para implementação de cache.
• ASP.NET Core: Para construção dos serviços web.
• AutoMapper: Para mapeamento entre entidades e DTOs.

---

🚀 Como executar o projeto

✅ Requisitos

• .NET 9 SDK instalado
• IDE como Visual Studio 2022+ ou Rider
• Banco de dados SQLITE -> www.sqlite.org

🔄 Clonando o repositório

git clone https://github.com/DevCoonnect/ViniciusDeJesus.git
cd ViniciusDeJesus

O projeto principal está nomeado como RickAndMorty

▶️ Executando a API

dotnet run --project RickAndMorty

A API será iniciada automaticamente no seu navegador padrão no endereço: https://localhost:7177

🔐 Autenticação

Primeiramente precisaremos criar uma SecretKey do tipo SHA256 e configurar os segredos do usuário dentro da IDE da seguinte forma:

{
    "Settings": {
        "SecretKey": "<sua-secretKey-SHA256-aqui>"
    }
}

A autenticação é feita via JWT. Para acessar endpoints protegidos, inclua o token no cabeçalho da requisição:

Authorization: Bearer <seu-token-jwt>

Tokens válidos podem ser gerados através do endpoint api/Authentication/Login onde é necessário enviar o "name" e a "password" do usuário no body da requisição, como no exemplo abaixo:

{
    "name": "admin",
    "password": "admin"
}

🧪 Testes

Execute os testes unitário e de integração com o seguinte comando:

dotnet test

A cobertura inclui testes de integração completos utilizando CustomWebApplicationFactory, banco SQLite em memória e autenticação fake personalizada (TestAuthHandler).

🧠 Regras de Negócio

Regra geral de todas as requisições: O retorno do erro 404 foi utilizado para os casos em que nenhum objeto foi encontrado no banco.

Localização (location)

• Localizações podem possuir residentes ou não.
  • Os residentes não são definidos diretamente no objeto location, mas sim alterando o campo de origem dos personagens,
• Criações e edições necessitam do preenchimento de todas as propriedades.

Personagem (character)

• Personagens possuem obrigatoriamente uma localização de origem (LocationId).
  • Portanto é necessário que exista pelo menos uma localização no banco para conseguirmos criar um personagem.
• Criações e edições necessitam do preenchimento de todas as propriedades.

Usuário (user)

• Os nomes dos usuários são únicos.
• Existem 3 possíveis perfis manager, employee e guest, sempre que um usuário é criado ele automaticamente recebe o perfil guest que possui o menor nível de acesso possível.
  • Existe uma exceção à regra acima, o primeiro usuário a ser criado no banco receberá o perfil de manager que possui o maior nível de acesso possível.
• Após a criação de um usuário é necessário autenticar seu acesso, para que você receba um token de usuário.
• Todos os tokens de usuários expiram após 10 minutos, sendo necessário autenticar novamente.

API Externa (external api)

• Esse endpoint é destinado a conexão com a API rickandmortyapi.com, onde podemos buscar todas as localizações e personagens.
  • Não é possível alterar nada, podemos apenas consultar os dados.
• O cache foi implementado nos endpoints api/ExternalApi/Location e api/ExternalApi/Character, será armazenado o retorno de todas as requisições que utilizarem o parâmetro name.

📍 Endpoints

Após executar o projeto conseguiremos interagir com o programa localmente através da url:

https://localhost:7177/api/{entidade}/{endpoint}?{parametros}

Os endpoints referentes a cada entidade são

Localização (entidade = Location)

• GET Busca de todas -> endpoint = GetAll
• GET Busca por Id -> endpoint = GetId & parametro Id = 1
• DELETE Deleção por Id -> endpoint = Delete & parametro Id = 1
• POST Criação -> endpoint = Create
• PATCH Atualização por Id -> enpoint = Update & parametro Id = 1

Personagem (entidade = Character)

• GET Busca de todos -> endpoint = GetAll
• GET Busca por Id -> endpoint = GetId & parametro Id = 1
• DELETE Deleção por Id -> endpoint = Delete & parametro Id = 1
• POST Criação -> endpoint = Create
• PATCH Atualização por Id -> enpoint = Update & parametro Id = 1

Usuário (entidade = User)

• GET Busca por Id -> endpoint = GetId & parametro Id = 1
• DELETE Deleção por Id -> endpoint = Delete & parametro Id = 1
• POST Criação -> endpoint = Create
• PATCH Atualização por Id -> enpoint = Update & parametro Id = 1

API Externa (entidade = ExternalApi)

• GET Busca por Localizações -> endpoint = Location

  • Parâmetros exclusivos
    • dimension: filtrar pela dimensão fornecida.

• GET Busca por Character -> endpoint = Character

  • Parâmetros exclusivos
    • species: filtrar pela espécie fornecida.
    • status: filtrar pelo status fornecido (alive, dead ou unknown).
    • gender: filtrar pelo gênero fornecido (female, male, genderless ou unknown).

• Parâmetros disponíveis para ambas as requisições

  • name: filtrar pelo nome fornecido.
  • type: filtrar pelo tipo fornecido.
  • expand: para personagens exibe sua localização e para localizações exibe seus residentes (true ou false).
  • page: você pode acessar diferentes páginas com o parâmetro page. Se você não especificar nenhuma página, a primeira página será exibida.

Autenticação (entidade = Authentication)

• POST Login do usuário -> endpoint = Login
• O body deve conter name e password

---

Início do desenvolvimento do projeto (08/08/2024), finalização (08/05/2025) Autor: Vinicius Niquini Andrade de Jesus Mentor: Lucas Pederzini Silva Créditos: Axel Fuhrmann