OriusTecnologia/saas_api
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

feat(Readem): Atualiza o readme

Browse source
This commit is contained in:
Keven 2025-12-29 16:19:46 -03:00
parent 2ce6843178
commit ae1cbca20c
1 changed files with 23 additions and 40 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

63
README.md
View file

@ -76,64 +76,49 @@ pip install -r requirements.txt
---
## 6. Configurar o Banco de Dados (Firebird)
## 6. Configuração do Banco de Dados (Firebird)
O projeto utiliza o banco **Firebird**.
Edite o arquivo de configuração em:
Crie o arquivo **`.env`** na raiz do projeto e configure as variáveis de ambiente necessárias para a conexão com o banco de dados Firebird:
```
api/config/database/firebird.json
```env
ORIUS_API_FDB_HOST=localhost
ORIUS_API_FDB_NAME=S:/Bases/SANTARITA.FDB
ORIUS_API_FDB_PORT=3050
ORIUS_API_FDB_USER=SYSDBA
ORIUS_API_FDB_PASSWORD=302b3c
ORIUS_API_FDB_CHARSET=UTF8
ORIUS_API_FDB_POOL_PRE_PING=true
ORIUS_API_FDB_POOL_SIZE=5
ORIUS_API_FDB_POOL_MAX_OVERFLOW=10
ORIUS_CLIENT_STATE=go
```
Exemplo:
```json
{
"host": "localhost",
"name": "/data/base/CAIAPONIA.FDB",
"port": 3050,
"user": "SYSDBA",
"password": "",
"charset": "UTF8",
"pool": {
"pre_ping": true,
"size": 5,
"max_overflow": 10
}
}
```
**Campos principais:**
| Campo | Descrição |
| ------------------- | ---------------------------------- |
| `host` | Endereço do servidor Firebird |
| `name` | Caminho completo do arquivo `.FDB` |
| `port` | Porta padrão `3050` |
| `user` | Usuário do banco |
| `password` | Senha do usuário |
| `charset` | Codificação (UTF8 recomendado) |
| `pool.size` | Número de conexões fixas |
| `pool.max_overflow` | Conexões extras sob demanda |
Essas configurações definem o acesso ao banco, o charset e o gerenciamento de conexões da aplicação.
---
## 7. Modo Desenvolvimento
Para ambiente local, execute:
Execute a aplicação em ambiente local:
```bash
uvicorn main:app --reload
```
> O parâmetro `--reload` reinicia automaticamente a aplicação ao detectar alterações no código.
O modo `--reload` recarrega a aplicação automaticamente ao detectar alterações no código.
Acesse:
Acesse a documentação da API em:
```
http://localhost:8000/docs
```
Opcionalmente, para expor a aplicação na rede:
```bash
uvicorn main:app --host 0.0.0.0 --port 8000 --reload
```
---
## 8. Modo Produção
@ -277,5 +262,3 @@ gunicorn main:app \
* Automatize o serviço em produção via **systemd** (ex: `/etc/systemd/system/saas_api.service`) para iniciar junto com o servidor.
---
uvicorn main:app --host 0.0.0.0 --port 8000 --reload