Empezar › Conceptos

Conceptos: workspace, API, versión

Comprende cómo organiza CispalMocks tus servicios REST y cómo interactúa con el sistema de archivos y Git.

Estructura jerárquica de CispalMocks

CispalMocks organiza tu trabajo en una jerarquía clara y natural diseñada para reflejar cómo los equipos construyen e integran servicios:

  • Workspace: Es una carpeta en tu disco. No contiene bases de datos propietarias ni formatos ocultos; todo son archivos JSON legibles por humanos y versionables en Git.
  • API: Representa un servicio lógico (por ejemplo, Pagos o Usuarios). Define una URL base, configuraciones de autenticación compartidas y scripts comunes.
  • Versión: Una iteración del contrato (como v1 o v2). Cada versión puede tener su propio servidor mock levantado en un puerto independiente y almacena sus propias grabaciones.
  • Operación: Una llamada concreta a un endpoint (por ejemplo, GET /users/{id} o POST /pedidos), con sus parámetros, cabeceras y bodies de prueba.
Árbol de navegación del workspace en CispalMocks con APIs, versiones y operaciones

Estructura en disco del workspace

Cuando trabajas en CispalMocks, tus archivos se guardan con una estructura limpia y predecible:

Estructura de archivos
mi-workspace/
├── workspace.json                  # Metadatos del workspace
├── environments/                   # Entornos de variables (dev, test, prod)
│   ├── dev.json
│   └── qa.json
└── apis/
    └── jsonplaceholder/
        ├── api.json                # Configuración de la API y autenticación
        └── v1/
            ├── version.json        # Configuración del mock y puerto
            ├── mappings/           # Stubs de WireMock generados (uno por petición)
            │   └── get-users-1.json
            └── __files/            # Cuerpos de respuesta grandes o binarios

Datos de usuario fuera del repositorio

Para evitar conflictos al compartir el workspace en Git, la configuración del usuario (historial reciente, preferencias de interfaz y secretos) se almacena fuera del proyecto en el directorio del sistema operativo:

Sistema Datos y configuración Caché
Windows %APPDATA%\CispalMocks %LOCALAPPDATA%\CispalMocks\Cache
macOS ~/Library/Application Support/CispalMocks ~/Library/Caches/CispalMocks
Linux ~/.config/cispalmocks ~/.cache/cispalmocks