marceloasf / plataforma-comunicacao

Plataforma de comunicação com agendamento de mensagens.

plataforma-comunicacao

Plataforma de comunicação com agendamento de mensagens. API feita com Java 11 e Spring Framework.

Comandos PostgreSQL para executar a aplicação

É necessário executar esses comandos em um ambiente que execute-os nativamente (por ex.: pgAdmin 4), para que o back-end se conecte com o banco e o liquibase execute os changesets requeridos da maneira esperada.

Nota sobre o server do banco de dados: Esses comandos devem ser executados em um server que esteja com o Host name/adress igual a localhost e Port igual a 5432, assim como definidos na property url: jdbc:postgresql://localhost:5432/comunicacao_db no arquivo application.yml do back-end.

1. CREATE DATABASE comunicacao_db;
2. CREATE USER comunicacao WITH ENCRYPTED PASSWORD 'comunicacao';
3. GRANT ALL PRIVILEGES ON DATABASE comunicacao_db TO comunicacao;
4. CREATE SCHEMA comunicacao AUTHORIZATION comunicacao; -- Criar o schema dentro do database "comunicacao_db"

Para fazer as requisições ao back-end utilizando uma aplicação como o Postman

Executar a classe ComunicacaoApplication, a qual irá inicializar o back-end da aplicação seguindo as properties definidas no arquivo application.yml. Após inicializar a aplicação, é possível utilizar as requisições citadas abaixo:

Para agendar uma nova comunicação, utilizar esse endpoint: POST: localhost:8080/api/comunicacoes

Exemplo de JSON para POST: 
{
	"dataEnvio": "2021-01-01T10:00:00",
	"destinatario": "[email protected]",
	"mensagem": "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.",
	"tipo": "EMAIL",
	"status": "AGENDADA"
}

Nota: Esse endpoint espera que o objeto vindo da requisição possua apenas os campos definidos como no exemplo acima (dataEnvio, destinatario, mensagem, tipo e status).

Para consultar o status de uma comunicação existente, utilizar esse endpoint: GET: localhost:8080/api/comunicacoes/id/status (substituir o id no path por algum criado no agendamento, o id do agendamento é criado sequencialmente)

Para excluir um agendamento existente, utilizar esse endpoint: DELETE: localhost:8080/api/comunicacoes/id (substituir o id da mesma maneira que o endpoint anterior)