64 lines
1.6 KiB
Markdown
64 lines
1.6 KiB
Markdown
# Guia de Uso da API - Agenda Digital para Estudantes
|
|
|
|
Esta API foi desenvolvida em **Java (Spring Boot)** com **MongoDB** para auxiliar estudantes na organização de tarefas e compromissos acadêmicos.
|
|
|
|
## Autenticação
|
|
|
|
A maioria dos endpoints requer autenticação via **Token JWT**. Para obtê-lo:
|
|
|
|
1. Realize o login em `POST /api/estudantes/login`.
|
|
2. Extraia o campo `token` do corpo da resposta.
|
|
3. Inclua o token no cabeçalho de todas as requisições subsequentes:
|
|
|
|
```
|
|
Authorization: Bearer SEU_TOKEN_AQUI
|
|
```
|
|
|
|
---
|
|
|
|
## Endpoints
|
|
|
|
### Estudantes
|
|
|
|
| Método | Rota | Descrição |
|
|
|--------|------|-----------|
|
|
| `POST` | `/api/estudantes/cadastro` | Cria um novo estudante |
|
|
| `POST` | `/api/estudantes/login` | Autentica e retorna o token JWT |
|
|
|
|
### Tarefas
|
|
|
|
| Método | Rota | Descrição |
|
|
|--------|------|-----------|
|
|
| `POST` | `/api/tarefas` | Cria uma nova tarefa |
|
|
| `GET` | `/api/tarefas/estudante/{id}` | Lista todas as tarefas de um estudante |
|
|
| `GET` | `/api/tarefas/estudante/{id}/pendentes` | Lista apenas as tarefas não concluídas |
|
|
| `GET` | `/api/tarefas/{id}` | Retorna os detalhes de uma tarefa específica |
|
|
| `PUT` | `/api/tarefas/{id}` | Atualiza os dados de uma tarefa existente |
|
|
| `PATCH` | `/api/tarefas/{id}/concluir` | Marca uma tarefa como concluída |
|
|
| `DELETE` | `/api/tarefas/{id}` | Remove uma tarefa |
|
|
|
|
---
|
|
|
|
## Formato de Resposta
|
|
|
|
Todas as respostas da API seguem a estrutura abaixo:
|
|
|
|
```json
|
|
{
|
|
"data": { ... },
|
|
"message": "Sucesso",
|
|
"timestamp": "2026-03-01T19:00:00"
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
## Execução
|
|
|
|
```bash
|
|
# Iniciar a aplicação
|
|
mvn spring-boot:run
|
|
|
|
# Executar os testes
|
|
mvn test
|
|
``` |