README.md

API de Setores

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

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ŕorio 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 backend_sector bash -c  "yarn && yarn jest --coverage --forceExit"

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

Rotas

GET: /sector/

Para receber os dados dos setores.

GET: /sector/:id

Para receber os dados de um setor específico utilizando o id.

GET: /sector/newest-four

Para receber os dados dos últimos quatro setores adicionados.

POST: /sector/create

Para criar um novo setor, envie os dados nesse formato:

{
    "name": "Nome do Setor",
    "description": "Descrição do Setor",
}

PUT: /sector/update/:id

Para atualizar os dados do setor, envie os dados atualizados seguindo o padrão:

{
   "name": "Nome do Setor",
    "description": "Descrição do Setor Atualizada",
}

DELETE: /sector/delete/:id

Para deletar um setor pelo id.