https://github.com/maxsonferovante/potiguar-api
A Potiguar API é um serviço projetado para facilitar a consulta de infrações de veículos, subsídios e multas no Rio Grande do Norte.
https://github.com/maxsonferovante/potiguar-api
api-rest async fastapi mongodb pynest python xhttp
Last synced: 2 months ago
JSON representation
A Potiguar API é um serviço projetado para facilitar a consulta de infrações de veículos, subsídios e multas no Rio Grande do Norte.
- Host: GitHub
- URL: https://github.com/maxsonferovante/potiguar-api
- Owner: maxsonferovante
- Created: 2024-10-07T22:32:10.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-10-23T00:34:52.000Z (7 months ago)
- Last Synced: 2025-01-30T09:16:59.759Z (4 months ago)
- Topics: api-rest, async, fastapi, mongodb, pynest, python, xhttp
- Language: Python
- Homepage: https://potiguar-api-production.up.railway.app/api/docs
- Size: 159 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Potiguar API
A Potiguar API é um serviço projetado para facilitar a consulta de infrações de veículos, subsídios e multas no Rio Grande do Norte. Ela fornece uma maneira robusta e eficiente de acessar e gerenciar essas informações através de uma API bem estruturada.
## Funcionalidades
- **FastAPI**: Utiliza FastAPI para construir a API, garantindo alto desempenho e interfaces fáceis de usar.
- **Celery**: Integra Celery para lidar com tarefas assíncronas, tornando-o adequado para processamento em segundo plano.
- **Uvicorn**: Usa Uvicorn como o servidor ASGI para servir a aplicação FastAPI.
- **Poetry**: Gerencia dependências e ambientes virtuais com Poetry, garantindo um ambiente consistente e reproduzível.
## Requisitos
- Python 3.12+
- Poetry
- Redis (para backend do Celery)
- FastAPI
- Uvicorn
- Celery
## Instalação
Siga os passos abaixo para configurar e executar a Potiguar API em sua máquina local.
## Iniciar Serviço
## Passo 1 - Criar ambiente
- Instale as dependências usando Poetry:
```bash
poetry install
```
## Passo 2 - Iniciar serviço localmente
1. Execute o serviço com Uvicorn:
```bash
uvicorn "src.app_module:http_server" --host "0.0.0.0" --port "8000" --reload
```
2. Inicie o worker do Celery e o Flower para monitoramento:
```bash
poetry run celery -A src.apps.tasks.tasks_service worker --loglevel=INFO
```
```bash
poetry run celery -A src.apps.tasks.tasks_service flower
```
## Passo 3 - Enviar requisições
Vá para a documentação do FastAPI e use seus endpoints da API - http://127.0.0.1/api/docs