Files
mini-erp/mini-backend/docs/index.md
T
2026-08-17 11:58:38 -05:00

51 lines
1.9 KiB
Markdown

# Backend — Documentación del Proyecto
Backend de integración entre el frontend `mini-frontend` (React 19 + TypeScript + Vite) y **SAP Business One Service Layer**. Actúa como proxy/middleware autenticando empleados, gestionando sesiones y enrutando operaciones CRUD hacia SAP. Este proyecto vive junto al frontend dentro del monorepo `mini-erp` (ver `CLAUDE.md` en la raíz del repo).
## Stack Tecnológico
| Componente | Tecnología |
| ------------- | ----------------- |
| Framework | FastAPI (Python) |
| Servidor ASGI | Uvicorn |
| HTTP Client | `requests` |
| Logging | JSON estructurado |
| Sesiones | In-memory |
## Diagrama de Contexto del Sistema
```mermaid
graph TB
subgraph "Frontend"
F[mini-frontend - React + Vite]
end
subgraph "Backend - FastAPI"
API[API Proxy\n:8000]
end
subgraph "SAP Business One"
SL[Service Layer\nREST API]
AG[API Gateway\nCrystal Reports]
DB[(SAP DB / HANA)]
end
F -->|HTTP /api/*| API
API -->|HTTP /b1s/v1| SL
API -->|HTTP rs/v1/*| AG
API -->|SQL directo| DB
SL --> DB
AG --> DB
```
## Documentos
| Documento | Descripción |
| ---------------------------------------- | ---------------------------------------------- |
| [Arquitectura](architecture.md) | Componentes, dependencias, middlewares, APIs |
| [Flujo de Autenticación](auth-flow.md) | Login, logout, sesiones, middleware |
| [Proxy SAP](sap-proxy.md) | Enrutamiento a SAP, re-autenticación, OData |
| [API Reference](api-reference.md) | Todos los endpoints, ejemplos request/response |
| [Diseño de logging](logging-plan.md) | Contexto de usuario/request, formato JSON |
| [Visualización de logs](logs-viewing.md) | Cómo leer `logs/backend.log` con `jq`/`lnav` |