ContaSelfAPI – Gerenciamento de Alunos e Cursos

Este projeto consiste em uma API ASP.NET C# para gerenciamento de alunos e cursos, com banco de dados MySQL, dados seed automáticos e interface frontend leve usando live-server.

---

1. Pré-requisitos

• .NET 9 SDK
• MySQL Workbench
• Node.js e npm
• Live-server (npm install -g live-server)

---

2. Estrutura do projeto

/Desafio-RestAPI-ContaSelf
│
├─ /backend
│    └─ src/
│          └─ RestAPI/          
│               └─ RestAPI.csproj           <- Projeto principal da API
│          └─ tests/ 
│               └─ ContaSelfAPI.Tests/      <- Testes unitários e de integração         
├─ /frontend
│    └─ css/               <- Estilização básica das páginas
│    └─ alunos.html        <- Interface via live-server para qualquer HTML
│    └─ cursos.html
│    └─ dashboard.html
│    └─ relatorios.html              
│    └─ ApiService.js      <- Código que faz chamadas a API
├─ /prompts      <- arquivos.md documentando o uso de IA

---

3. Passos para rodar o projeto

3.1 Configurar o banco de dados

1. Após baixar os arquivos, importe o arquivo 'backend/src/RestAPI/docs/tabelasBanco.sql' em seu MySql Workbench.
2. Ajuste a connection string no Banco.cs da API, alterando o valor das váriaveis declaradas anteriormente, se necessário:

  private static string Host = "localhost";
  private static string User = "root";
  private static string Password = "";
  private static string Database = "ContaSelf";
  private static string Port = "3306";

Outra opção é importar o arquivo .sql em uma conexão com os dados de Host, Passowrd, User e Port iguais aos da API.

3. Inicialize os dados seed executando qualquer uma das rotas de conexão ao banco:

GET http://localhost:8080/alunos
GET http://localhost:8080/cursos
POST http://localhost:8080/alunos
POST http://localhost:8080/cursos

Isso criará as tabelas e populá-las com dados iniciais.

---

3.2 Rodar a API

1. Navegue até a pasta raíz do projeto da API:

cd backend/src/RestAPI
dotnet run

2. A API estará disponível em:

http://localhost:8080

---

3.3 Rodar o frontend

1. Navegue até a pasta do frontend (a partir da pasta raíz):

cd frontend

2. Execute o live-server na porta 5500:

live-server --port=5500

3. Abra no navegador caso não seja redirecionado automaticamente:

http://127.0.0.1:5500

Clique em Dashboard.html para ser direcionado a página inicial

3.4 Informações sobre as páginas de navegação

1. Dashboard

• Os botões são hiperlinks para as páginas referenciadas.

2. Alunos

• Listar: Exibe todos os alunos.
• Filtrar: Precisa que um dos campos 'ID do curso' ou 'Nome do curso' esteja preenchido.
• Criar: Os três primeiros campos precisam estar preenchidos.
• Filtrar via URI: Digite '?curso_id={numero}' ou '?curso={nome}' no fim da URI

3. Cursos

• Criar: Precisa de um nome válido para que ocorra inserção.

---

4. Exemplos de requisições (Insomnia)

4.1 Listar todos os alunos

GET http://localhost:8080/alunos

4.2 Listar todos os cursos

GET http://localhost:8080/cursos

4.3 Filtrar alunos por curso (nome ou ID)

GET http://localhost:8080/alunos?curso=Administração
GET http://localhost:8080/alunos?curso_id=3

4.4 Criar um novo curso

POST http://localhost:8080/cursos
header: "Content-Type: application/json"
body json: '{"curso":{"nome": "abcde"}}'

4.5 Criar um novo aluno

POST http://localhost:8080/alunos \
header: "Content-Type: application/json" \
body json: '{"aluno": {"nome": "Amanda", "idade": 22, "curso_id": 1}}'

4.6 Gerar gelatórios

GET http://localhost:8080/relatorios

---

5. Testes automatizados

• Unitários: backend/tests/ContaSelfAPI.Tests/AlunoTests.cs
• Integração de endpoints: backend/tests/ContaSelfAPI.Tests/AlunoApiIntegrationTests.cs

Rodar todos os testes:

cd backend/tests
dotnet test

---

6. Como usei IA

• Criação e revisão do frontend em HTML/JS e manipulação via ApiService.js.
• Auxílio na API ASP.NET C# (endpoints, filtragem via query string, tratamento de UTF-8).
• Sugestões de estrutura de testes unitários e de integração.
• Documentação de passo a passo (README.md) e prompts detalhados para consultas futuras.

---

7. Observações

• O banco deve estar criado antes de rodar a API.
• Deve estar ativado o MySql no Xampp
• Frontend deve ser servido via live-server para evitar problemas de CORS.
• Para novos testes, use o projeto ContaSelfAPI.Tests dentro da pasta tests.

---

🎥 Demonstração em Vídeo

Assista ao vídeo completo apresentando o funcionamento da API, o banco de dados e a interface web:

➡️ Clique aqui para assistir no YouTube