README.md

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

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

POST: /category/create

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

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

PUT: /category/update/:id

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

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

DELETE: /category/delete/:id

Para deletar uma categoria pelo id.