https://github.com/peulearning/plataforma-comunicacao
https://github.com/peulearning/plataforma-comunicacao
Last synced: 18 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/peulearning/plataforma-comunicacao
- Owner: peulearning
- Created: 2025-02-07T21:39:17.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-02-07T23:14:16.000Z (over 1 year ago)
- Last Synced: 2025-02-07T23:26:49.768Z (over 1 year ago)
- Language: Java
- Size: 9.77 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Agendador de Notificações
Esse projeto foi desenvolvido para um desafio técnico visando apresentar habilidades de desenvolvedor java backend e tem como escopo o cadastro de notificações para posterior envio.
## Rodando localmente
Clone o projeto
```bash
git clone https://link-para-o-projeto
```
Entre no diretório do projeto
```bash
docker-compose up --build
```
## Documentação da API
#### Cadastra notificações pendentes
```http
POST /agendamento
```
| Body | Tipo | Descrição |
| :---------- | :--------- | :---------------------------------- |
| `emailDestinatario` | `string` | **Obrigatório**. Email do destinatário da notificação |
| `telefoneDestinatario` | `string` | **Obrigatório**. Telefone do destinatário da notificação |
| `mensagem` | `string` | **Obrigatório**. Mensagem da notificação |
| `dataHoraEvento` | `LocalDateTime` | **Obrigatório**. Data hora do evento no formado dd-MM-yyyy HH:mm:ss |
#### Retorna uma notificação por id
```http
GET /agendamento/${id}
```
| Parâmetro | Tipo | Descrição |
| :---------- | :--------- | :------------------------------------------ |
| `id` | `string` | **Obrigatório**. O ID do item que você quer buscar |
#### Cancela uma notificação por id
```http
DELETE /agendamento/${id}
```
| Parâmetro | Tipo | Descrição |
| :---------- | :--------- | :------------------------------------------ |
| `id` | `string` | **Obrigatório**. O ID do item que você quer cancelar |
## Rodando os testes
Para rodar os testes, rode o seguinte comando
```bash
mvn test
```