API de Usuários

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

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

Como rodar?

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 3001.

Rotas

GET: /users/

Para receber os dados dos usuários.

POST: /signup/

Para criar um novo usuário, envie os dados nesse formato:

{
    "name": "Nome do Usuário",
    "email": "[email protected]",
    "role": "Cargo",
    "sector": "Area de Atuação",
    "pass": "Senha"
}

POST: /login/

Para entrar no sitema, envie os dados nesse formato:

{
    "email": "[email protected]",
    "pass": "Senha"
}

PUT: /users/update/:id

Para atualizar os dados do usuário, envie os dados atualizados seguindo o padrão:

{
    "name": "Nome do Usuário",
    "email": "[email protected]",
    "role": "Cargo",
    "sector": "Area de Atuação",
    "pass": "Senha"
}

DELETE: /users/delete/:id

Para desativar um cliente pelo id.