API de Demandas

Essa API faz parte da arquitetura de microsserviços do projeto SiGeD, sua funcionalidade é possibilitar o controle dos dados das demandas.

Como contribuir?

Gostaria de contribuir com nosso projeto? Acesse o nosso guia de contribuição onde são explicados todos os passos. Caso reste duvidas você também pode entrar em contato conosco criando uma issue.

Documentação

A documentação do projeto pode ser acessada pelo nosso site em https://fga-eps-mds.github.io/2020-2-SiGeD/ ou você pode acessar pela SiGeD Documentação

Testes

Todas as funções adicionadas nessa API devem ser testadas, o repositório aceita até 10% do total de lihas não testadas. Para rodar os testes nesse repositŕio deve ser executado o comando:

docker-compose run api_demands bash -c  "yarn && yarn jest --coverage --forceExit"

Como rodar?

O arquivo .env possui configurações iniciais que podem ser alteradas de acordo com a necessidade. São elas:

• SECRET: chave para criptografia das senhas.
• CLIENTS_URL: conexão entre a api de demandas e clientes.
• USERS_URL: conexão entre a api de usuários e demandas.
• DB_USER: usuário de acesso ao banco de dados.
• DB_PASS: senha de acesso ao banco de dados.
• DB_NAME: nome da base de dados.
• DB_HOST: host da base de dados.

Se os servidores mudarem, deve-se colocar o IP os campos CLIENTS_URL e USERS_URL.

Veja o exemplo abaixo:

SECRET=chavedesegredo
CLIENTS_URL=backend_clients
USERS_URL=backend_users
DB_USER=api_user
DB_PASS=api_password
DB_NAME=api_database
DB_HOST=db_demands

Para rodar a API é preciso usar os seguintes comandos usando o docker:

Crie uma network para os containers da API, caso não exista:

docker network create siged_backend

Suba o container com o comando:

docker-compose up

A API estará rodando na porta 3003.

Rotas

GET: /category/

Para receber os dados de todas as categorias listadas.

GET: /category/:id

Para receber os dados de uma categoria específica utilizando o id.

GET: /demand/

Para receber os dados de todas as demandas listadas.

GET: /demand/:id

Para receber os dados de uma demanda específica utilizando o id.

GET: /demand/newest-four

Para receber as últimas quatro demandas demandas listadas.

GET: /clientsNames

Para receber as demandas com os nomes dos clientes.

GET: /demand/history/:id

Para receber o histórico de uma demanda específica utilizando o id.

GET: /statistic/category

Para receber os dados das estatísticas por categoria.

GET: /statistic/sector

Para receber os dados das estatísticas por setor.

GET: /alert

Para receber os dados de todos os alertas listados.

GET: /alert/demand/:demandID

Para receber os dados dos alertas pelo id da demanda.

GET: /alert/sector/:sectorID

Para receber os dados dos alertas pelo id do setor.

POST: /category/create

Para criar uma nova categoria, envie os dados nesse formato:

{
    "name": "Nome da categoria",
    "description": "Descrição da categoria",
    "color": "#000000"
}

POST: /demand/create

Para criar uma nova demanda, envie os dados nesse formato:

{
    "name": "Nome da demanda",
    "description": "Descrição da demanda",
    "process": "43017",
    "sectorID": "6074c01561b3ce0040c55222",
	"clientID": "6078cf89f3be730047d7d618",
	"userID": "608a32ff3b3afd003fa6b37e",
	"categoryID": ["6074bfadd1d77900489f67d5"]
}

POST: /alert/create

Para criar uma nova categorias, envie os dados nesse formato:

{
	"name": "Nome do alerta",
	"description": "Descrição do alerta",
	"date": "2021-05-04",
	"alertClient": false,
	"checkbox": false,
	"demandID": "608a0f642571c900403f00c3",
	"sectorID": "608a0ee34314020047e2a7d6"
}

PUT: /category/update/:id

Para atualizar os dados de uma categoria, envie os dados atualizados seguindo o padrão:

{
    "name": "Nome da categoria atualizado",
    "description": "Descrição da categoria",
    "color": "#000000"
}

PUT: /demand/update/:id

Para atualizar os dados de uma demanda, envie os dados atualizados seguindo o padrão:

{
    "name": "Nome da demanda atualizado",
    "description": "Descrição da demanda atualizada",
    "process": "43012",
    "sectorID": "6074c01561b3ce0040c55222",
	"clientID": "6078cf89f3be730047d7d618",
	"userID": "608a32ff3b3afd003fa6b37e",
	"categoryID": ["6074bfadd1d77900489f67d5"]
}

PUT: /demand/sectorupdate/:id

Para atualizar o setor de uma demanda.

{
 	"sectorID": "1283719487924"
}

PUT: /demand/forward/:id

Para encaminhar uma demanda para outro setor, envie os dados atualizados seguindo o padrão:

{
 	"sectorID": "12871837283"
}

PUT: /demand/toggle/:id

Utilizado para ativar ou desativar uma demanda.

PUT: /demand/create-demand-update/:id

Para criar uma atualização da demanda.

{
    "userName": "edit",
    "userSector": "607b48d22cb2cc0040c1765a",
    "description": "edited 2 description",
    "visibilityRestriction": false,
    "updateListID": "607902e8e733220040b65f24"
}

PUT: /demand/update-demand-update/:id

Para atualizar a atualização da demanda.

{
    "userName": "edit",
    "userSector": "607b48d22cb2cc0040c1765a",
    "description": "edited 2 description",
    "visibilityRestriction": false,
    "updateListID": "607902e8e733220040b65f24"
}

PUT: /demand/delete-demand-update/:id

Para deletar a atualização da demanda.

PUT: /alert/update/:id

Para atualizar os dados de um alerta, envie os dados atualizados seguindo o padrão:

{
	"name": "Nome do alerta atualizado",
	"description": "Descrição do alerta atualizada",
	"date": "2021-05-04",
	"alertClient": false,
	"checkbox": true,
	"demandID": "608a0f642571c900403f00c3",
	"sectorID": "608a0ee34314020047e2a7d6"
}

DELETE: /category/delete/:id

Para deletar uma categoria pelo id.

DELETE: /alert/delete/:id

Para deletar um alerta pelo id.