rckrdmrd/workspace-v1
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
967ab360bb
workspace-v1/projects/erp-suite/apps/verticales/construccion/docs/97-adr/ADR-008-api-design.md
Adrian Flores Cortes 967ab360bb Initial commit: Workspace v1 with 3-layer architecture 
Structure:
- control-plane/: Registries, SIMCO directives, CI/CD templates
- projects/: Gamilit, ERP-Suite, Trading-Platform, Betting-Analytics
- shared/: Libs catalog, knowledge-base

Key features:
- Centralized port, domain, database, and service registries
- 23 SIMCO directives + 6 fundamental principles
- NEXUS agent profiles with delegation rules
- Validation scripts for workspace integrity
- Dockerfiles for all services
- Path aliases for quick reference

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-23 00:35:19 -06:00

1.7 KiB
Raw Blame History

ADR-008: API Design RESTful

Estado: Aceptada Fecha: 2025-11-24 Responsable: Architecture-Analyst Proyecto: ERP Construccion

Contexto

APIs deben soportar:

  • Operaciones CRUD para todos los modulos
  • Integraciones con INFONAVIT
  • App movil para asistencias
  • Portal de derechohabientes

Decision

API RESTful con:

  • Versionado: /api/v1/
  • JSON como formato de datos
  • Autenticacion JWT
  • Rate limiting para integraciones externas
/api/v1/
+-- /auth/              # Autenticacion
+-- /projects/          # Proyectos de construccion
+-- /phases/            # Etapas de fraccionamiento
+-- /lots/              # Lotes/viviendas
+-- /estimates/         # Estimaciones
+-- /infonavit/         # Endpoints INFONAVIT
+-- /portal/            # Portal derechohabientes

Justificacion

Referencia a Odoo

  • Odoo usa JSON-RPC, pero REST es mas estandar
  • Endpoints similares a Odoo models

Especifico para Construccion

  • /portal/* para derechohabientes (read-only)
  • /infonavit/* para reportes regulatorios
  • /mobile/* para app de asistencias GPS

Consecuencias

Positivas

  • API estandar y documentada (OpenAPI)
  • Facil integracion con terceros
  • Compatible con app movil

Negativas

  • No tan flexible como GraphQL
  • Mitigacion: Endpoints especificos para reportes complejos

Implementacion

Acciones Requeridas

  • Setup Express con versionado
  • Documentar con OpenAPI/Swagger
  • Implementar rate limiting
  • Endpoints especificos para INFONAVIT

Criterios de Aceptacion

  • Documentacion OpenAPI completa
  • Rate limiting funcional
  • Integracion INFONAVIT probada

Referencias