vncsmyrnk / integracao-restaurantes-api

API REST responsável por controlar o armazenamento e recuperação de informações dos restaurantes

API Integração em restaurantes

API REST responsável por controlar o armazenamento e recuperação de informações dos restaurantes.

É utilizado o Koyeb como plataforma de produção para a API e para o banco de dados.

O DB utilizado é uma instância do postgreSQL, hospedada também no Koyeb. Foi implementada uma estrutura de migrations para controlar as versões das entidades.

Essa API tem o objetivo de centralizar as informações relacionadas a pedido de um restaurante em apenas um lugar, fornecendo webhooks para que outros sistemas possam tomar decisões baseadas na movimentação dos pedidos.

Executando com Docker

docker build --build-arg="DB_CON_STRING=<DB_CON_STRING>" ro .
docker run --rm -it -p 5000:5000 ro

Exemplo de utilização

$ curl -X GET -H "Content-Type: application/json" localhost:5000/api/ingrediente -s | jq .

Resultado:

[
  {
    "created_at": "Thu, 09 May 2024 20:51:47 GMT",
    "descricao": "Lorem ipsum",
    "id": 7,
    "nome": "Arroz"
  }
]

Documentação

A API possui documentação publicada no GitBook.

Desenvolvimento

docker build --target base --tag ro-dev .
docker run --rm -it -v "$(pwd)"/src:/var/app -p 5000:5000 ro-dev bash
flask --app server run --host 0.0.0.0