Ir al contenido

Proyectos y archivos .restorm

Un proyecto Restorm vive en su disco. No hay espacio de trabajo remoto ni sincronización propietaria: usted abre un archivo, lo guarda y lo confirma en git.

El modo por defecto (Archivo ▸ Nuevo y luego Guardar como). Todo el proyecto cabe en un solo archivo, en YAML por defecto. Hay otros dos formatos de serialización disponibles: json y json5.

Archivo ▸ Abrir una carpeta. El proyecto se despliega en un árbol sobre el disco, lo que produce diffs mucho más precisos en los proyectos grandes:

  • un archivo de configuración restorm.conf en la raíz, que solo contiene el formato (format: yaml | json | json5);
  • un archivo de índice por directorio (index.yaml, index.json…);
  • las carpetas y archivos nombrados <índice> - <nombre>, con el índice completado con ceros según el ancho del conjunto de hermanos, para que el orden en pantalla sea el orden en el disco. Los caracteres prohibidos (<>:"/\|?*) se sustituyen por _ y el nombre se recorta a 100 caracteres.

En modo carpeta, Ctrl+S solo escribe el subárbol de la pestaña activa; Ctrl+Shift+S (Guardar todo) escribe el conjunto.

Un proyecto abierto en modo carpeta: el árbol de la izquierda reproduce la jerarquía de la carpeta y la barra de estado apunta a una carpeta, no a un archivo .restorm.

  • el árbol: carpetas, carpetas de variables, peticiones de todos los protocolos, escenarios;
  • los entornos y sus variables, incluidos los subentornos;
  • las listas de valores personalizadas y las enumeraciones importadas;
  • las etiquetas y sus colores;
  • la documentación de API adjunta a las carpetas de variables;
  • los ajustes rápidos guardados «en el proyecto»;
  • un identificador de proyecto (_projectUuid) y una versión de formato.

De forma deliberada, para que el archivo sea compartible:

DatoDónde vive
SecretosUn archivo .env de secretos junto al proyecto — consulte Secretos
Historial de respuestasUn archivo comprimido <proyecto>.responses.zip colocado junto al proyecto
Ajustes rápidos «de usuario»Su configuración local
FavoritosEl almacenamiento local de la aplicación, indexado por identificador de proyecto
Disposición del workbenchSu configuración local, indexada por proyecto
Ajustes del espacio de trabajo<carpeta-del-proyecto>/.restorm/settings.json

Consecuencia práctica: puede confirmar un .restorm en git sin filtrar ningún token, y su compañero no recibe su disposición de pestañas.

Dos garantías, que existen únicamente para que el control de versiones sea utilizable:

  1. Orden de claves canónico. Las claves de identidad van primero (id, name, key, type, folderType, method, url) y el resto se ordena alfabéticamente. El orden de los arreglos, en cambio, no se modifica nunca: es su orden.
  2. Identificadores derivados de forma estable. El identificador de una entidad se calcula a partir de su ruta semántica, no se sortea al azar. Dos personas que añaden la misma petición en el mismo lugar producen el mismo identificador, lo que permite que la fusión empareje correctamente las entidades.

Resultado: abrir y volver a guardar un proyecto sin cambiar nada no produce ningún diff. Consulte Git integrado.

Archivo ▸ Archivos recientes enumera los diez últimos proyectos abiertos; las rutas que han dejado de ser válidas se retiran automáticamente. La misma lista alimenta la pantalla de bienvenida.